@@ -228,6 +228,7 @@ x-tagGroups:
228
228
- custom_field_definition
229
229
- shipping_method
230
230
- dunning_campaigns
231
+ - business_entities
231
232
tags:
232
233
- name: site
233
234
x-displayName: Site
@@ -374,6 +375,10 @@ tags:
374
375
description: An account from an external resource that is not managed by the Recurly
375
376
platform and instead is managed by third-party platforms like Apple App Store
376
377
and Google Play Store.
378
+ - name: business_entities
379
+ x-displayName: Business Entities
380
+ description: Describes the business address that will be used for invoices and taxes
381
+ depending on settings and subscriber location.
377
382
paths:
378
383
"/sites":
379
384
get:
@@ -15974,6 +15979,60 @@ paths:
15974
15979
schema:
15975
15980
"$ref": "#/components/schemas/Error"
15976
15981
x-code-samples: []
15982
+ "/business_entities/{business_entity_id}":
15983
+ parameters:
15984
+ - "$ref": "#/components/parameters/business_entity_id"
15985
+ get:
15986
+ tags:
15987
+ - business_entities
15988
+ operationId: get_business_entity
15989
+ summary: Fetch a business entity
15990
+ responses:
15991
+ '200':
15992
+ description: Business entity details
15993
+ content:
15994
+ application/json:
15995
+ schema:
15996
+ "$ref": "#/components/schemas/BusinessEntity"
15997
+ '404':
15998
+ description: Incorrect site or business entity ID.
15999
+ content:
16000
+ application/json:
16001
+ schema:
16002
+ "$ref": "#/components/schemas/Error"
16003
+ default:
16004
+ description: Unexpected error.
16005
+ content:
16006
+ application/json:
16007
+ schema:
16008
+ "$ref": "#/components/schemas/Error"
16009
+ x-code-samples: []
16010
+ "/business_entities":
16011
+ get:
16012
+ tags:
16013
+ - business_entities
16014
+ operationId: list_business_entities
16015
+ summary: List business entities
16016
+ responses:
16017
+ '200':
16018
+ description: List of all business entities on your site.
16019
+ content:
16020
+ application/json:
16021
+ schema:
16022
+ "$ref": "#/components/schemas/BusinessEntityList"
16023
+ '404':
16024
+ description: Incorrect site.
16025
+ content:
16026
+ application/json:
16027
+ schema:
16028
+ "$ref": "#/components/schemas/Error"
16029
+ default:
16030
+ description: Unexpected error.
16031
+ content:
16032
+ application/json:
16033
+ schema:
16034
+ "$ref": "#/components/schemas/Error"
16035
+ x-code-samples: []
15977
16036
"/gift_cards":
15978
16037
get:
15979
16038
tags:
@@ -16143,6 +16202,49 @@ paths:
16143
16202
schema:
16144
16203
"$ref": "#/components/schemas/Error"
16145
16204
x-code-samples: []
16205
+ "/business_entities/{business_entity_id}/invoices":
16206
+ get:
16207
+ tags:
16208
+ - invoice
16209
+ operationId: list_business_entity_invoices
16210
+ summary: List a business entity's invoices
16211
+ description: See the [Pagination Guide](/developers/guides/pagination.html)
16212
+ to learn how to use pagination in the API and Client Libraries.
16213
+ parameters:
16214
+ - "$ref": "#/components/parameters/business_entity_id"
16215
+ - "$ref": "#/components/parameters/ids"
16216
+ - "$ref": "#/components/parameters/limit"
16217
+ - "$ref": "#/components/parameters/order"
16218
+ - "$ref": "#/components/parameters/sort_dates"
16219
+ - "$ref": "#/components/parameters/filter_begin_time"
16220
+ - "$ref": "#/components/parameters/filter_end_time"
16221
+ - "$ref": "#/components/parameters/filter_invoice_type"
16222
+ responses:
16223
+ '200':
16224
+ description: A list of the business entity's invoices.
16225
+ content:
16226
+ application/json:
16227
+ schema:
16228
+ "$ref": "#/components/schemas/InvoiceList"
16229
+ '400':
16230
+ description: Invalid or unpermitted parameter.
16231
+ content:
16232
+ application/json:
16233
+ schema:
16234
+ "$ref": "#/components/schemas/Error"
16235
+ '404':
16236
+ description: Incorrect site or business entity ID.
16237
+ content:
16238
+ application/json:
16239
+ schema:
16240
+ "$ref": "#/components/schemas/Error"
16241
+ default:
16242
+ description: Unexpected error.
16243
+ content:
16244
+ application/json:
16245
+ schema:
16246
+ "$ref": "#/components/schemas/Error"
16247
+ x-code-samples: []
16146
16248
servers:
16147
16249
- url: https://v3.recurly.com
16148
16250
- url: https://v3.eu.recurly.com
@@ -16180,6 +16282,14 @@ components:
16180
16282
required: true
16181
16283
schema:
16182
16284
type: string
16285
+ business_entity_id:
16286
+ name: business_entity_id
16287
+ in: path
16288
+ description: Business Entity ID. For ID no prefix is used e.g. `e28zov4fw0v2`.
16289
+ For code use prefix `code-`, e.g. `code-entity1`.
16290
+ required: true
16291
+ schema:
16292
+ type: string
16183
16293
usage_id:
16184
16294
name: usage_id
16185
16295
in: path
@@ -17101,6 +17211,11 @@ components:
17101
17211
merchant has an integration for the Vertex tax provider, this optional
17102
17212
value will be sent in any tax calculation requests for the account.
17103
17213
maxLength: 30
17214
+ override_business_entity_id:
17215
+ type: string
17216
+ title: Override Business Entity ID
17217
+ description: Unique ID to identify the business entity assigned to the account.
17218
+ Available when the `Multiple Business Entities` feature is enabled.
17104
17219
parent_account_code:
17105
17220
type: string
17106
17221
maxLength: 50
@@ -17169,6 +17284,11 @@ components:
17169
17284
The customer will also use this email address to log into your hosted
17170
17285
account management pages. This value does not need to be unique.
17171
17286
maxLength: 255
17287
+ override_business_entity_id:
17288
+ type: string
17289
+ title: Override Business Entity ID
17290
+ description: Unique ID to identify the business entity assigned to the account.
17291
+ Available when the `Multiple Business Entities` feature is enabled.
17172
17292
preferred_locale:
17173
17293
description: Used to determine the language and locale of emails sent on
17174
17294
behalf of the merchant to the customer.
@@ -19358,6 +19478,11 @@ components:
19358
19478
type: boolean
19359
19479
title: Final Dunning Event
19360
19480
description: Last communication attempt.
19481
+ business_entity_id:
19482
+ type: string
19483
+ title: Business Entity ID
19484
+ description: Unique ID to identify the business entity assigned to the invoice.
19485
+ Available when the `Multiple Business Entities` feature is enabled.
19361
19486
InvoiceCreate:
19362
19487
type: object
19363
19488
properties:
@@ -23939,6 +24064,84 @@ components:
23939
24064
type: string
23940
24065
description: Username of the associated payment method. Currently only associated
23941
24066
with Venmo.
24067
+ BusinessEntityList:
24068
+ type: object
24069
+ properties:
24070
+ object:
24071
+ type: string
24072
+ title: Object type
24073
+ description: Will always be List.
24074
+ has_more:
24075
+ type: boolean
24076
+ description: Indicates there are more results on subsequent pages.
24077
+ next:
24078
+ type: string
24079
+ description: Path to subsequent page of results.
24080
+ data:
24081
+ type: array
24082
+ items:
24083
+ "$ref": "#/components/schemas/BusinessEntity"
24084
+ BusinessEntity:
24085
+ type: object
24086
+ description: Business entity details
24087
+ properties:
24088
+ id:
24089
+ title: Business entity ID
24090
+ type: string
24091
+ maxLength: 13
24092
+ readOnly: true
24093
+ object:
24094
+ title: Object type
24095
+ type: string
24096
+ readOnly: true
24097
+ code:
24098
+ title: Business entity code
24099
+ type: string
24100
+ maxLength: 50
24101
+ description: The entity code of the business entity.
24102
+ name:
24103
+ type: string
24104
+ title: Name
24105
+ description: This name describes your business entity and will appear on
24106
+ the invoice.
24107
+ maxLength: 255
24108
+ invoice_display_address:
24109
+ title: Invoice display address
24110
+ description: Address information for the business entity that will appear
24111
+ on the invoice.
24112
+ "$ref": "#/components/schemas/Address"
24113
+ tax_address:
24114
+ title: Tax address
24115
+ description: Address information for the business entity that will be used
24116
+ for calculating taxes.
24117
+ "$ref": "#/components/schemas/Address"
24118
+ default_vat_number:
24119
+ type: string
24120
+ title: Default VAT number
24121
+ description: VAT number for the customer used on the invoice.
24122
+ maxLength: 20
24123
+ default_registration_number:
24124
+ type: string
24125
+ title: Default registration number
24126
+ description: Registration number for the customer used on the invoice.
24127
+ maxLength: 30
24128
+ subscriber_location_countries:
24129
+ type: array
24130
+ title: Subscriber location countries
24131
+ description: List of countries for which the business entity will be used.
24132
+ items:
24133
+ type: string
24134
+ title: Country code
24135
+ created_at:
24136
+ type: string
24137
+ format: date-time
24138
+ title: Created at
24139
+ readOnly: true
24140
+ updated_at:
24141
+ type: string
24142
+ format: date-time
24143
+ title: Last updated at
24144
+ readOnly: true
23942
24145
GiftCardList:
23943
24146
type: object
23944
24147
properties:
0 commit comments