recurly 4.8.0 → 4.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +1 -1
  3. data/.travis.yml +3 -1
  4. data/CHANGELOG.md +49 -0
  5. data/GETTING_STARTED.md +1 -1
  6. data/lib/recurly/client/operations.rb +46 -3
  7. data/lib/recurly/client.rb +12 -4
  8. data/lib/recurly/connection_pool.rb +11 -9
  9. data/lib/recurly/requests/account_create.rb +4 -0
  10. data/lib/recurly/requests/account_purchase.rb +4 -0
  11. data/lib/recurly/requests/account_update.rb +4 -0
  12. data/lib/recurly/requests/add_on_create.rb +2 -2
  13. data/lib/recurly/requests/add_on_pricing.rb +4 -0
  14. data/lib/recurly/requests/billing_info_create.rb +24 -0
  15. data/lib/recurly/requests/invoice_collect.rb +1 -1
  16. data/lib/recurly/requests/line_item_create.rb +6 -2
  17. data/lib/recurly/requests/plan_pricing.rb +4 -0
  18. data/lib/recurly/requests/pricing.rb +4 -0
  19. data/lib/recurly/requests/purchase_create.rb +1 -1
  20. data/lib/recurly/requests/subscription_change_create.rb +5 -1
  21. data/lib/recurly/requests/subscription_change_shipping_create.rb +8 -0
  22. data/lib/recurly/requests/subscription_create.rb +5 -1
  23. data/lib/recurly/requests/subscription_purchase.rb +4 -0
  24. data/lib/recurly/requests/subscription_update.rb +9 -1
  25. data/lib/recurly/resources/account.rb +4 -0
  26. data/lib/recurly/resources/account_invoice_template.rb +18 -0
  27. data/lib/recurly/resources/add_on_pricing.rb +4 -0
  28. data/lib/recurly/resources/invoice.rb +1 -1
  29. data/lib/recurly/resources/line_item.rb +7 -3
  30. data/lib/recurly/resources/plan_pricing.rb +4 -0
  31. data/lib/recurly/resources/pricing.rb +4 -0
  32. data/lib/recurly/resources/subscription.rb +16 -0
  33. data/lib/recurly/resources/subscription_change.rb +4 -0
  34. data/lib/recurly/version.rb +1 -1
  35. data/openapi/api.yaml +291 -21
  36. metadata +4 -3
data/openapi/api.yaml CHANGED
@@ -232,7 +232,7 @@ tags:
232
232
  description: |-
233
233
  For merchants who sell the same things to many customers, documenting those offerings in a catalog allows for faster charge creation, easier management of offerings, and analytics about your offerings across all sales channels. Because your offerings can be physical, digital, or service-oriented, Recurly collectively calls these offerings "Items".
234
234
 
235
- Recurly's item catalog requires the Credit Invoices and Subscription Billing Terms features to be enabled.
235
+ Recurly's item catalog requires the Credit Invoices features to be enabled.
236
236
  - name: plan
237
237
  x-displayName: Plan
238
238
  description: A plan tells Recurly how often and how much to charge your customers.
@@ -6337,6 +6337,51 @@ paths:
6337
6337
  {\n\t\tfmt.Printf(\"Resource not found: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
6338
6338
  Recurly error: %v\", e)\n\treturn nil, err\n}\nfmt.Printf(\"Fetched Custom
6339
6339
  Field Definition: %s\", definition.Id)"
6340
+ "/invoice_templates/{invoice_template_id}/accounts":
6341
+ get:
6342
+ tags:
6343
+ - account
6344
+ operationId: list_invoice_template_accounts
6345
+ summary: List an invoice template's associated accounts
6346
+ description: See the [Pagination Guide](/guides/pagination.html) to learn how
6347
+ to use pagination in the API and Client Libraries.
6348
+ parameters:
6349
+ - "$ref": "#/components/parameters/invoice_template_id"
6350
+ - "$ref": "#/components/parameters/ids"
6351
+ - "$ref": "#/components/parameters/limit"
6352
+ - "$ref": "#/components/parameters/order"
6353
+ - "$ref": "#/components/parameters/sort_dates"
6354
+ - "$ref": "#/components/parameters/filter_begin_time"
6355
+ - "$ref": "#/components/parameters/filter_end_time"
6356
+ - "$ref": "#/components/parameters/filter_account_email"
6357
+ - "$ref": "#/components/parameters/filter_account_subscriber"
6358
+ - "$ref": "#/components/parameters/filter_account_past_due"
6359
+ responses:
6360
+ '200':
6361
+ description: A list of an invoice template's associated accounts.
6362
+ content:
6363
+ application/json:
6364
+ schema:
6365
+ "$ref": "#/components/schemas/AccountList"
6366
+ '400':
6367
+ description: Invalid or unpermitted parameter.
6368
+ content:
6369
+ application/json:
6370
+ schema:
6371
+ "$ref": "#/components/schemas/Error"
6372
+ '404':
6373
+ description: Incorrect site or invoice template ID.
6374
+ content:
6375
+ application/json:
6376
+ schema:
6377
+ "$ref": "#/components/schemas/Error"
6378
+ default:
6379
+ description: Unexpected error.
6380
+ content:
6381
+ application/json:
6382
+ schema:
6383
+ "$ref": "#/components/schemas/Error"
6384
+ x-code-samples: []
6340
6385
  "/items":
6341
6386
  get:
6342
6387
  tags:
@@ -12611,7 +12656,16 @@ paths:
12611
12656
  - subscription_change
12612
12657
  operationId: create_subscription_change
12613
12658
  summary: Create a new subscription change
12614
- description: Calling this will overwrite an existing, pending subscription change.
12659
+ description: |
12660
+ Calling this will overwrite an existing, pending subscription change.
12661
+
12662
+ If a subscription has a pending change, and a change is submitted which matches
12663
+ the subscription as it currently exists, the pending change will be deleted,
12664
+ and you will receive a 204 No Content response.
12665
+
12666
+ If a subscription has no pending
12667
+ change, and a change is submitted which matches the subscription as it currently
12668
+ exists, a 422 Unprocessable Entity validation error will be returned.
12615
12669
  parameters:
12616
12670
  - "$ref": "#/components/parameters/subscription_id"
12617
12671
  requestBody:
@@ -12627,6 +12681,8 @@ paths:
12627
12681
  application/json:
12628
12682
  schema:
12629
12683
  "$ref": "#/components/schemas/SubscriptionChange"
12684
+ '204':
12685
+ description: The previous pending change was reverted.
12630
12686
  '404':
12631
12687
  description: Incorrect site ID.
12632
12688
  content:
@@ -14568,7 +14624,8 @@ components:
14568
14624
  billing_info_id:
14569
14625
  name: billing_info_id
14570
14626
  in: path
14571
- description: Billing Info ID.
14627
+ description: Billing Info ID. Can ONLY be used for sites utilizing the Wallet
14628
+ feature.
14572
14629
  required: true
14573
14630
  schema:
14574
14631
  type: string
@@ -14602,6 +14659,13 @@ components:
14602
14659
  required: true
14603
14660
  schema:
14604
14661
  type: string
14662
+ invoice_template_id:
14663
+ name: invoice_template_id
14664
+ in: path
14665
+ description: Invoice template ID.
14666
+ required: true
14667
+ schema:
14668
+ type: string
14605
14669
  item_id:
14606
14670
  name: item_id
14607
14671
  in: path
@@ -15444,6 +15508,12 @@ components:
15444
15508
  dunning campaign should be assigned to this account. For sites without
15445
15509
  multiple dunning campaigns enabled, the default dunning campaign will
15446
15510
  always be used.
15511
+ invoice_template_id:
15512
+ type: string
15513
+ title: Invoice Template ID
15514
+ description: Unique ID to identify an invoice template. Available when
15515
+ the Invoice Customization feature is enabled. Used to specify which invoice
15516
+ template, if any, should be used to generate invoices for the account.
15447
15517
  address:
15448
15518
  "$ref": "#/components/schemas/Address"
15449
15519
  billing_info:
@@ -15528,6 +15598,8 @@ components:
15528
15598
  "$ref": "#/components/schemas/BillingInfo"
15529
15599
  custom_fields:
15530
15600
  "$ref": "#/components/schemas/CustomFields"
15601
+ invoice_template:
15602
+ "$ref": "#/components/schemas/AccountInvoiceTemplate"
15531
15603
  AccountNote:
15532
15604
  type: object
15533
15605
  required:
@@ -15624,6 +15696,20 @@ components:
15624
15696
  format: float
15625
15697
  title: Amount
15626
15698
  description: Total amount the account is past due.
15699
+ AccountInvoiceTemplate:
15700
+ type: object
15701
+ title: Invoice Template
15702
+ description: Invoice template associated to the account. Available when invoice
15703
+ customization flag is enabled.
15704
+ properties:
15705
+ id:
15706
+ type: string
15707
+ title: ID
15708
+ description: Unique ID to identify the invoice template.
15709
+ name:
15710
+ type: string
15711
+ title: Name
15712
+ description: Template name
15627
15713
  InvoiceAddress:
15628
15714
  allOf:
15629
15715
  - "$ref": "#/components/schemas/Address"
@@ -15888,16 +15974,16 @@ components:
15888
15974
  type: string
15889
15975
  title: Item Code
15890
15976
  description: Unique code to identify an item. Available when the `Credit
15891
- Invoices` and `Subscription Billing Terms` features are enabled. If `item_id`
15892
- and `item_code` are both present, `item_id` will be used.
15977
+ Invoices` feature are enabled. If `item_id` and `item_code` are both present,
15978
+ `item_id` will be used.
15893
15979
  pattern: "/^[a-z0-9_+-]+$/"
15894
15980
  maxLength: 50
15895
15981
  item_id:
15896
15982
  type: string
15897
15983
  title: Item ID
15898
15984
  description: System-generated unique identifier for an item. Available when
15899
- the `Credit Invoices` and `Subscription Billing Terms` features are enabled.
15900
- If `item_id` and `item_code` are both present, `item_id` will be used.
15985
+ the `Credit Invoices` feature is enabled. If `item_id` and `item_code`
15986
+ are both present, `item_id` will be used.
15901
15987
  maxLength: 13
15902
15988
  code:
15903
15989
  type: string
@@ -16334,6 +16420,28 @@ components:
16334
16420
  characters comprising a country code; two check digits; and a number that
16335
16421
  includes the domestic bank account number, branch identifier, and potential
16336
16422
  routing information
16423
+ name_on_account:
16424
+ type: string
16425
+ maxLength: 255
16426
+ description: The name associated with the bank account (ACH, SEPA, Bacs
16427
+ only)
16428
+ account_number:
16429
+ type: string
16430
+ maxLength: 255
16431
+ description: The bank account number. (ACH, Bacs only)
16432
+ routing_number:
16433
+ type: string
16434
+ maxLength: 15
16435
+ description: The bank's rounting number. (ACH only)
16436
+ sort_code:
16437
+ type: string
16438
+ maxLength: 15
16439
+ description: Bank identifier code for UK based banks. Required for Bacs
16440
+ based billing infos. (Bacs only)
16441
+ type:
16442
+ "$ref": "#/components/schemas/AchTypeEnum"
16443
+ account_type:
16444
+ "$ref": "#/components/schemas/AchAccountTypeEnum"
16337
16445
  tax_identifier:
16338
16446
  type: string
16339
16447
  description: Tax identifier is required if adding a billing info that is
@@ -17344,7 +17452,8 @@ components:
17344
17452
  description: The `billing_info_id` is the value that represents a specific
17345
17453
  billing info for an end customer. When `billing_info_id` is used to assign
17346
17454
  billing info to the subscription, all future billing events for the subscription
17347
- will bill to the specified billing info.
17455
+ will bill to the specified billing info. `billing_info_id` can ONLY be
17456
+ used for sites utilizing the Wallet feature.
17348
17457
  subscription_ids:
17349
17458
  type: array
17350
17459
  title: Subscription IDs
@@ -17601,7 +17710,8 @@ components:
17601
17710
  description: The `billing_info_id` is the value that represents a specific
17602
17711
  billing info for an end customer. When `billing_info_id` is used to assign
17603
17712
  billing info to the subscription, all future billing events for the subscription
17604
- will bill to the specified billing info.
17713
+ will bill to the specified billing info. `billing_info_id` can ONLY be
17714
+ used for sites utilizing the Wallet feature.
17605
17715
  InvoiceCollection:
17606
17716
  type: object
17607
17717
  title: Invoice collection
@@ -17852,20 +17962,20 @@ components:
17852
17962
  type: string
17853
17963
  title: Item Code
17854
17964
  description: Unique code to identify an item. Available when the Credit
17855
- Invoices and Subscription Billing Terms features are enabled.
17965
+ Invoices feature is enabled.
17856
17966
  pattern: "/^[a-z0-9_+-]+$/"
17857
17967
  maxLength: 50
17858
17968
  item_id:
17859
17969
  type: string
17860
17970
  title: Item ID
17861
17971
  description: System-generated unique identifier for an item. Available when
17862
- the Credit Invoices and Subscription Billing Terms features are enabled.
17972
+ the Credit Invoices feature is enabled.
17863
17973
  maxLength: 13
17864
17974
  external_sku:
17865
17975
  type: string
17866
17976
  title: External SKU
17867
17977
  description: Optional Stock Keeping Unit assigned to an item. Available
17868
- when the Credit Invoices and Subscription Billing Terms features are enabled.
17978
+ when the Credit Invoices feature is enabled.
17869
17979
  maxLength: 50
17870
17980
  revenue_schedule_type:
17871
17981
  title: Revenue schedule type
@@ -17887,6 +17997,12 @@ components:
17887
17997
  "$ref": "#/components/schemas/LegacyCategoryEnum"
17888
17998
  account:
17889
17999
  "$ref": "#/components/schemas/AccountMini"
18000
+ bill_for_account_id:
18001
+ type: string
18002
+ title: Bill For Account ID
18003
+ maxLength: 13
18004
+ description: The UUID of the account responsible for originating the line
18005
+ item.
17890
18006
  subscription_id:
17891
18007
  type: string
17892
18008
  title: Subscription ID
@@ -18139,6 +18255,13 @@ components:
18139
18255
  A positive or negative amount with `type=credit` will result in a negative `unit_amount`.
18140
18256
  If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the
18141
18257
  `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
18258
+ tax_inclusive:
18259
+ type: boolean
18260
+ title: Tax Inclusive?
18261
+ default: false
18262
+ description: Determines whether or not tax is included in the unit amount.
18263
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
18264
+ feature) must be enabled to use this flag.
18142
18265
  quantity:
18143
18266
  type: integer
18144
18267
  title: Quantity
@@ -18155,14 +18278,14 @@ components:
18155
18278
  type: string
18156
18279
  title: Item Code
18157
18280
  description: Unique code to identify an item. Available when the Credit
18158
- Invoices and Subscription Billing Terms features are enabled.
18281
+ Invoices feature is enabled.
18159
18282
  pattern: "/^[a-z0-9_+-]+$/"
18160
18283
  maxLength: 50
18161
18284
  item_id:
18162
18285
  type: string
18163
18286
  title: Item ID
18164
18287
  description: System-generated unique identifier for an item. Available when
18165
- the Credit Invoices and Subscription Billing Terms features are enabled.
18288
+ the Credit Invoices feature is enabled.
18166
18289
  maxLength: 13
18167
18290
  revenue_schedule_type:
18168
18291
  title: Revenue schedule type
@@ -18652,6 +18775,13 @@ components:
18652
18775
  title: Unit price
18653
18776
  minimum: 0
18654
18777
  maximum: 1000000
18778
+ tax_inclusive:
18779
+ type: boolean
18780
+ title: Tax Inclusive?
18781
+ default: false
18782
+ description: Determines whether or not tax is included in the unit amount.
18783
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
18784
+ feature) must be enabled to use this flag.
18655
18785
  PlanUpdate:
18656
18786
  type: object
18657
18787
  properties:
@@ -18810,6 +18940,13 @@ components:
18810
18940
  description: |
18811
18941
  Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`.
18812
18942
  If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
18943
+ tax_inclusive:
18944
+ type: boolean
18945
+ title: Tax Inclusive?
18946
+ default: false
18947
+ description: Determines whether or not tax is included in the unit amount.
18948
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
18949
+ feature) must be enabled to use this flag.
18813
18950
  required:
18814
18951
  - currency
18815
18952
  TierPricing:
@@ -18852,6 +18989,13 @@ components:
18852
18989
  title: Unit price
18853
18990
  minimum: 0
18854
18991
  maximum: 1000000
18992
+ tax_inclusive:
18993
+ type: boolean
18994
+ title: Tax Inclusive?
18995
+ default: false
18996
+ description: Determines whether or not tax is included in the unit amount.
18997
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
18998
+ feature) must be enabled to use this flag.
18855
18999
  required:
18856
19000
  - currency
18857
19001
  - unit_amount
@@ -19443,6 +19587,16 @@ components:
19443
19587
  format: float
19444
19588
  title: Estimated total, before tax.
19445
19589
  minimum: 0
19590
+ tax:
19591
+ type: number
19592
+ format: float
19593
+ title: Estimated tax
19594
+ tax_info:
19595
+ "$ref": "#/components/schemas/TaxInfo"
19596
+ total:
19597
+ type: number
19598
+ format: float
19599
+ title: Estimated total
19446
19600
  collection_method:
19447
19601
  title: Collection method
19448
19602
  default: automatic
@@ -19502,6 +19656,12 @@ components:
19502
19656
  set. This timestamp is used for alerting customers to reauthorize in 3
19503
19657
  years in accordance with NACHA rules. If a subscription becomes inactive
19504
19658
  or the billing info is no longer a bank account, this timestamp is cleared.
19659
+ gateway_code:
19660
+ type: string
19661
+ title: Gateway Code
19662
+ description: If present, this subscription's transactions will use the payment
19663
+ gateway with this code.
19664
+ maxLength: 13
19505
19665
  billing_info_id:
19506
19666
  type: string
19507
19667
  title: Billing Info ID
@@ -19773,6 +19933,13 @@ components:
19773
19933
  type: number
19774
19934
  format: float
19775
19935
  title: Unit amount
19936
+ tax_inclusive:
19937
+ type: boolean
19938
+ title: Tax Inclusive?
19939
+ default: false
19940
+ description: Determines whether or not tax is included in the unit amount.
19941
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
19942
+ feature) must be enabled to use this flag.
19776
19943
  quantity:
19777
19944
  type: integer
19778
19945
  title: Subscription quantity
@@ -19860,6 +20027,13 @@ components:
19860
20027
  be used.
19861
20028
  minimum: 0
19862
20029
  maximum: 1000000
20030
+ tax_inclusive:
20031
+ type: boolean
20032
+ title: Tax Inclusive?
20033
+ default: false
20034
+ description: Determines whether or not tax is included in the unit amount.
20035
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
20036
+ feature) must be enabled to use this flag.
19863
20037
  quantity:
19864
20038
  type: integer
19865
20039
  title: Quantity
@@ -19934,8 +20108,10 @@ components:
19934
20108
  SubscriptionChangeShippingCreate:
19935
20109
  type: object
19936
20110
  title: Shipping details that will be changed on a subscription
19937
- description: The shipping address can currently only be changed immediately,
19938
- using SubscriptionUpdate.
20111
+ description: Shipping addresses are tied to a customer's account. Each account
20112
+ can have up to 20 different shipping addresses, and if you have enabled multiple
20113
+ subscriptions per account, you can associate different shipping addresses
20114
+ to each subscription.
19939
20115
  properties:
19940
20116
  method_id:
19941
20117
  type: string
@@ -19956,6 +20132,13 @@ components:
19956
20132
  format: float
19957
20133
  title: Assigns the subscription's shipping cost. If this is greater than
19958
20134
  zero then a `method_id` or `method_code` is required.
20135
+ address_id:
20136
+ type: string
20137
+ titpe: Shipping address ID
20138
+ description: Assign a shipping address from the account's existing shipping
20139
+ addresses. If this and address are both present, address will take precedence.
20140
+ address:
20141
+ "$ref": "#/components/schemas/ShippingAddressCreate"
19959
20142
  SubscriptionCreate:
19960
20143
  type: object
19961
20144
  properties:
@@ -19979,7 +20162,8 @@ components:
19979
20162
  description: The `billing_info_id` is the value that represents a specific
19980
20163
  billing info for an end customer. When `billing_info_id` is used to assign
19981
20164
  billing info to the subscription, all future billing events for the subscription
19982
- will bill to the specified billing info.
20165
+ will bill to the specified billing info. `billing_info_id` can ONLY be
20166
+ used for sites utilizing the Wallet feature.
19983
20167
  shipping:
19984
20168
  title: Shipping address
19985
20169
  description: Create a shipping address on the account and assign it to the
@@ -20003,6 +20187,13 @@ components:
20003
20187
  the subscription plan for the provided currency.
20004
20188
  minimum: 0
20005
20189
  maximum: 1000000
20190
+ tax_inclusive:
20191
+ type: boolean
20192
+ title: Tax Inclusive?
20193
+ default: false
20194
+ description: Determines whether or not tax is included in the unit amount.
20195
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
20196
+ feature) must be enabled to use this flag.
20006
20197
  quantity:
20007
20198
  type: integer
20008
20199
  title: Quantity
@@ -20134,6 +20325,13 @@ components:
20134
20325
  the subscription plan for the provided currency.
20135
20326
  minimum: 0
20136
20327
  maximum: 1000000
20328
+ tax_inclusive:
20329
+ type: boolean
20330
+ title: Tax Inclusive?
20331
+ default: false
20332
+ description: Determines whether or not tax is included in the unit amount.
20333
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
20334
+ feature) must be enabled to use this flag.
20137
20335
  quantity:
20138
20336
  type: integer
20139
20337
  title: Quantity
@@ -20264,6 +20462,19 @@ components:
20264
20462
  at 31 days exactly.
20265
20463
  minimum: 0
20266
20464
  default: 0
20465
+ gateway_code:
20466
+ type: string
20467
+ title: Gateway Code
20468
+ description: If present, this subscription's transactions will use the payment
20469
+ gateway with this code.
20470
+ maxLength: 13
20471
+ tax_inclusive:
20472
+ type: boolean
20473
+ title: Tax Inclusive?
20474
+ default: false
20475
+ description: Determines whether or not tax is included in the unit amount.
20476
+ The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing
20477
+ feature) must be enabled to use this flag.
20267
20478
  shipping:
20268
20479
  "$ref": "#/components/schemas/SubscriptionShippingUpdate"
20269
20480
  billing_info_id:
@@ -20272,7 +20483,8 @@ components:
20272
20483
  description: The `billing_info_id` is the value that represents a specific
20273
20484
  billing info for an end customer. When `billing_info_id` is used to assign
20274
20485
  billing info to the subscription, all future billing events for the subscription
20275
- will bill to the specified billing info.
20486
+ will bill to the specified billing info. `billing_info_id` can ONLY be
20487
+ used for sites utilizing the Wallet feature.
20276
20488
  SubscriptionPause:
20277
20489
  type: object
20278
20490
  properties:
@@ -20870,7 +21082,8 @@ components:
20870
21082
  description: The `billing_info_id` is the value that represents a specific
20871
21083
  billing info for an end customer. When `billing_info_id` is used to assign
20872
21084
  billing info to the subscription, all future billing events for the subscription
20873
- will bill to the specified billing info.
21085
+ will bill to the specified billing info. `billing_info_id` can ONLY be
21086
+ used for sites utilizing the Wallet feature.
20874
21087
  collection_method:
20875
21088
  title: Collection method
20876
21089
  description: Must be set to manual in order to preview a purchase for an
@@ -21338,20 +21551,26 @@ components:
21338
21551
  - en-AU
21339
21552
  - en-CA
21340
21553
  - en-GB
21554
+ - en-IE
21341
21555
  - en-NZ
21342
21556
  - en-US
21343
21557
  - es-ES
21344
21558
  - es-MX
21345
21559
  - es-US
21560
+ - fi-FI
21346
21561
  - fr-CA
21347
21562
  - fr-FR
21348
21563
  - hi-IN
21564
+ - it-IT
21349
21565
  - ja-JP
21566
+ - ko-KR
21350
21567
  - nl-BE
21351
21568
  - nl-NL
21352
21569
  - pt-BR
21353
21570
  - pt-PT
21571
+ - ro-RO
21354
21572
  - ru-RU
21573
+ - sk-SK
21355
21574
  - tr-TR
21356
21575
  - zh-CN
21357
21576
  BillToEnum:
@@ -21491,16 +21710,22 @@ components:
21491
21710
  OriginEnum:
21492
21711
  type: string
21493
21712
  enum:
21713
+ - carryforward_credit
21714
+ - carryforward_gift_credit
21494
21715
  - credit
21716
+ - external_refund
21495
21717
  - gift_card
21496
21718
  - immediate_change
21719
+ - import
21497
21720
  - line_item_refund
21498
21721
  - open_amount_refund
21722
+ - prepayment
21499
21723
  - purchase
21724
+ - refund
21500
21725
  - renewal
21501
21726
  - termination
21727
+ - usage_correction
21502
21728
  - write_off
21503
- - prepayment
21504
21729
  InvoiceStateEnum:
21505
21730
  type: string
21506
21731
  enum:
@@ -21737,6 +21962,7 @@ components:
21737
21962
  - roku
21738
21963
  - sepadirectdebit
21739
21964
  - wire_transfer
21965
+ - braintree_v_zero
21740
21966
  CardTypeEnum:
21741
21967
  type: string
21742
21968
  enum:
@@ -21812,6 +22038,7 @@ components:
21812
22038
  - ach_transactions_not_supported
21813
22039
  - ach_validation_exception
21814
22040
  - amazon_amount_exceeded
22041
+ - amazon_declined_review
21815
22042
  - amazon_invalid_authorization_status
21816
22043
  - amazon_invalid_close_attempt
21817
22044
  - amazon_invalid_create_order_reference
@@ -21828,13 +22055,17 @@ components:
21828
22055
  - batch_processing_error
21829
22056
  - billing_agreement_already_accepted
21830
22057
  - billing_agreement_not_accepted
22058
+ - billing_agreement_not_found
22059
+ - billing_agreement_replaced
21831
22060
  - call_issuer
21832
22061
  - call_issuer_update_cardholder_data
22062
+ - cancelled
21833
22063
  - cannot_refund_unsettled_transactions
21834
22064
  - card_not_activated
21835
22065
  - card_type_not_accepted
21836
22066
  - cardholder_requested_stop
21837
22067
  - contact_gateway
22068
+ - contract_not_found
21838
22069
  - currency_not_supported
21839
22070
  - customer_canceled_transaction
21840
22071
  - cvv_required
@@ -21846,9 +22077,12 @@ components:
21846
22077
  - declined_saveable
21847
22078
  - declined_security_code
21848
22079
  - deposit_referenced_chargeback
22080
+ - direct_debit_type_not_accepted
21849
22081
  - duplicate_transaction
21850
22082
  - exceeds_daily_limit
22083
+ - exceeds_max_amount
21851
22084
  - expired_card
22085
+ - finbot_disconnect
21852
22086
  - finbot_unavailable
21853
22087
  - fraud_address
21854
22088
  - fraud_address_recurly
@@ -21856,36 +22090,45 @@ components:
21856
22090
  - fraud_gateway
21857
22091
  - fraud_generic
21858
22092
  - fraud_ip_address
22093
+ - fraud_manual_decision
21859
22094
  - fraud_risk_check
21860
22095
  - fraud_security_code
21861
22096
  - fraud_stolen_card
21862
22097
  - fraud_too_many_attempts
21863
22098
  - fraud_velocity
22099
+ - gateway_account_setup_incomplete
21864
22100
  - gateway_error
21865
22101
  - gateway_rate_limited
21866
22102
  - gateway_timeout
21867
22103
  - gateway_token_not_found
21868
22104
  - gateway_unavailable
22105
+ - gateway_validation_exception
21869
22106
  - insufficient_funds
21870
22107
  - invalid_account_number
21871
22108
  - invalid_amount
22109
+ - invalid_billing_agreement_status
21872
22110
  - invalid_card_number
21873
22111
  - invalid_data
21874
22112
  - invalid_email
21875
- - invalid_gateway_configuration
21876
22113
  - invalid_gateway_access_token
22114
+ - invalid_gateway_configuration
21877
22115
  - invalid_issuer
21878
22116
  - invalid_login
21879
22117
  - invalid_merchant_type
22118
+ - invalid_name
22119
+ - invalid_payment_method
22120
+ - invalid_payment_method_hard
21880
22121
  - invalid_transaction
21881
22122
  - issuer_unavailable
21882
22123
  - merch_max_transaction_limit_exceeded
22124
+ - moneybot_disconnect
21883
22125
  - moneybot_unavailable
21884
22126
  - no_billing_information
21885
22127
  - no_gateway
21886
22128
  - no_gateway_found_for_transaction_amount
21887
22129
  - partial_approval
21888
22130
  - partial_credits_not_supported
22131
+ - payer_authentication_rejected
21889
22132
  - payment_cannot_void_authorization
21890
22133
  - payment_not_accepted
21891
22134
  - paypal_account_issue
@@ -21895,7 +22138,9 @@ components:
21895
22138
  - paypal_hard_decline
21896
22139
  - paypal_invalid_billing_agreement
21897
22140
  - paypal_primary_declined
22141
+ - processor_not_available
21898
22142
  - processor_unavailable
22143
+ - recurly_credentials_not_found
21899
22144
  - recurly_error
21900
22145
  - recurly_failed_to_get_token
21901
22146
  - recurly_token_mismatch
@@ -21903,10 +22148,19 @@ components:
21903
22148
  - reference_transactions_not_enabled
21904
22149
  - restricted_card
21905
22150
  - restricted_card_chargeback
22151
+ - rjs_token_expired
22152
+ - roku_invalid_card_number
22153
+ - roku_invalid_cib
22154
+ - roku_invalid_payment_method
22155
+ - roku_zip_code_mismatch
21906
22156
  - simultaneous
21907
22157
  - ssl_error
21908
22158
  - temporary_hold
22159
+ - three_d_secure_action_required
22160
+ - three_d_secure_action_result_token_mismatch
21909
22161
  - three_d_secure_authentication
22162
+ - three_d_secure_connection_error
22163
+ - three_d_secure_credential_error
21910
22164
  - three_d_secure_not_supported
21911
22165
  - too_many_attempts
21912
22166
  - total_credit_exceeds_capture
@@ -21918,10 +22172,13 @@ components:
21918
22172
  - transaction_cannot_be_voided
21919
22173
  - transaction_failed_to_settle
21920
22174
  - transaction_not_found
22175
+ - transaction_service_v2_disconnect
22176
+ - transaction_service_v2_unavailable
21921
22177
  - transaction_settled
21922
22178
  - transaction_stale_at_gateway
21923
22179
  - try_again
21924
22180
  - unknown
22181
+ - unmapped_partner_error
21925
22182
  - vaultly_service_unavailable
21926
22183
  - zero_dollar_auth_not_supported
21927
22184
  ExportDates:
@@ -21974,3 +22231,16 @@ components:
21974
22231
  - automatic
21975
22232
  - manual
21976
22233
  - trial
22234
+ AchTypeEnum:
22235
+ type: string
22236
+ description: The payment method type for a non-credit card based billing info.
22237
+ `bacs` and `becs` are the only accepted values.
22238
+ enum:
22239
+ - bacs
22240
+ - becs
22241
+ AchAccountTypeEnum:
22242
+ type: string
22243
+ description: The bank account type. (ACH only)
22244
+ enum:
22245
+ - checking
22246
+ - savings