openapi/api.yaml in recurly-4.53.0 vs openapi/api.yaml in recurly-4.54.0
- old
+ new
@@ -18146,15 +18146,18 @@
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
+ the request then `tax_code` must be absent.
display_quantity:
type: boolean
title: Display quantity?
description: Determines if the quantity field is displayed on the hosted
pages for the add-on.
@@ -18365,18 +18368,18 @@
for more available t/s types. If an `Item` is associated to the `AddOn`,
then the `avalara_service_type` must be absent.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Optional field used by Avalara, Vertex, and Recurly's EU VAT
- tax feature to determine taxation rules. If you have your own AvaTax or
- Vertex account configured, use their tax codes to assign specific tax
- rules. If you are using Recurly's EU VAT feature, you can use values of
- `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part
- of the request then `tax_code` must be absent.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes. If `item_code`/`item_id` is part of
+ the request then `tax_code` must be absent.
currencies:
type: array
title: Add-on pricing
items:
"$ref": "#/components/schemas/AddOnPricing"
@@ -18520,18 +18523,18 @@
for more available t/s types. If an `Item` is associated to the `AddOn`,
then the `avalara_service_type` must be absent.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Optional field used by Avalara, Vertex, and Recurly's EU VAT
- tax feature to determine taxation rules. If you have your own AvaTax or
- Vertex account configured, use their tax codes to assign specific tax
- rules. If you are using Recurly's EU VAT feature, you can use values of
- `unknown`, `physical`, or `digital`. If an `Item` is associated to the
- `AddOn` then `tax code` must be absent.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes. If an `Item` is associated to the
+ `AddOn` then `tax_code` must be absent.
display_quantity:
type: boolean
title: Display quantity?
description: Determines if the quantity field is displayed on the hosted
pages for the add-on.
@@ -19806,15 +19809,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the item, `false` applies tax on the
item."
@@ -19914,15 +19919,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the item, `false` applies tax on the
item."
@@ -20010,15 +20017,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the item, `false` applies tax on the
item."
@@ -20464,11 +20473,20 @@
type: number
format: float
title: Amount
description: |
The amount to be refunded. The amount will be split between the line items.
- If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+ If `type` is "amount" and no amount is specified, it will default to refunding the total refundable amount on the invoice. Can only be present if `type` is "amount".
+ percentage:
+ type: integer
+ title: Percentage
+ description: The percentage of the remaining balance to be refunded. The
+ percentage will be split between the line items. If `type` is "percentage"
+ and no percentage is specified, it will default to refunding 100% of the
+ refundable amount on the invoice. Can only be present if `type` is "percentage".
+ minimum: 1
+ maximum: 100
line_items:
type: array
title: Line items
description: The line items to be refunded. This is required when `type=line_items`.
items:
@@ -20480,11 +20498,11 @@
- `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled.
- `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled.
- `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled.
- `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.
default: credit_first
- "$ref": "#/components/schemas/RefuneMethodEnum"
+ "$ref": "#/components/schemas/RefundMethodEnum"
credit_customer_notes:
type: string
title: Credit customer notes
description: |
Used as the Customer Notes on the credit invoice.
@@ -20871,15 +20889,17 @@
Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_info:
"$ref": "#/components/schemas/TaxInfo"
origin_tax_address_source:
"$ref": "#/components/schemas/OriginTaxAddressSourceEnum"
destination_tax_address_source:
@@ -20949,19 +20969,39 @@
title: Line item ID
maxLength: 13
quantity:
type: integer
title: Quantity
- description: Line item quantity to be refunded.
+ description: Line item quantity to be refunded. Must be less than or equal
+ to the `quantity_remaining`. If `quantity_decimal`, `amount`, and `percentage`
+ are not present, `quantity` is required. If `amount` or `percentage` is
+ present, `quantity` must be absent.
quantity_decimal:
type: string
title: Quantity Decimal
- description: A floating-point alternative to Quantity. If this value is
- present, it will be used in place of Quantity for calculations, and Quantity
- will be the rounded integer value of this number. This field supports
- up to 9 decimal places. The Decimal Quantity feature must be enabled to
- utilize this field.
+ description: Decimal quantity to refund. The `quantity_decimal` will be
+ used to refund charges that has a NOT null quantity decimal. Must be less
+ than or equal to the `quantity_decimal_remaining`. If `quantity`, `amount`,
+ and `percentage` are not present, `quantity_decimal` is required. If `amount`
+ or `percentage` is present, `quantity_decimal` must be absent. The Decimal
+ Quantity feature must be enabled to utilize this field.
+ amount:
+ type: number
+ format: float
+ description: The specific amount to be refunded from the adjustment. Must
+ be less than or equal to the adjustment's remaining balance. If `quantity`,
+ `quantity_decimal` and `percentage` are not present, `amount` is required.
+ If `quantity`, `quantity_decimal`, or `percentage` is present, `amount`
+ must be absent.
+ percentage:
+ type: integer
+ description: The percentage of the adjustment's remaining balance to refund.
+ If `quantity`, `quantity_decimal` and `amount_in_cents` are not present,
+ `percentage` is required. If `quantity`, `quantity_decimal` or `amount_in_cents`
+ is present, `percentage` must be absent.
+ minimum: 1
+ maximum: 100
prorate:
type: boolean
title: Prorate
description: |
Set to `true` if the line item should be prorated; set to `false` if not.
@@ -21093,17 +21133,17 @@
for more available t/s types. If an `Item` is associated to the `LineItem`,
then the `avalara_service_type` must be absent.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Optional field used by Avalara, Vertex, and Recurly's EU VAT
- tax feature to determine taxation rules. If you have your own AvaTax or
- Vertex account configured, use their tax codes to assign specific tax
- rules. If you are using Recurly's EU VAT feature, you can use values of
- `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
product_code:
type: string
title: Product code
description: Optional field to track a product code or SKU for the line
item. This can be used to later reporting on product purchases. For Vertex
@@ -21297,15 +21337,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Used by Avalara, Vertex, and Recurly’s EU VAT tax feature.
- The tax code values are specific to each tax system. If you are using
- Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the plan, `false` applies tax on the
plan."
@@ -21510,17 +21552,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Optional field used by Avalara, Vertex, and Recurly's EU VAT
- tax feature to determine taxation rules. If you have your own AvaTax or
- Vertex account configured, use their tax codes to assign specific tax
- rules. If you are using Recurly's EU VAT feature, you can use values of
- `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the plan, `false` applies tax on the
plan."
@@ -21774,17 +21816,17 @@
to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types)
for more available t/s types.
minimum: 0
tax_code:
type: string
- title: Tax code
- description: Optional field used by Avalara, Vertex, and Recurly's EU VAT
- tax feature to determine taxation rules. If you have your own AvaTax or
- Vertex account configured, use their tax codes to assign specific tax
- rules. If you are using Recurly's EU VAT feature, you can use values of
- `unknown`, `physical`, or `digital`.
maxLength: 50
+ title: Tax code
+ description: Optional field used by Avalara, Vertex, and Recurly's In-the-Box
+ tax solution to determine taxation rules. You can pass in specific tax
+ codes using any of these tax integrations. For Recurly's In-the-Box tax
+ offering you can also choose to instead use simple values of `unknown`,
+ `physical`, or `digital` tax codes.
tax_exempt:
type: boolean
title: Tax exempt?
description: "`true` exempts tax on the plan, `false` applies tax on the
plan."
@@ -26229,12 +26271,13 @@
- manual
InvoiceRefundTypeEnum:
type: string
enum:
- amount
+ - percentage
- line_items
- RefuneMethodEnum:
+ RefundMethodEnum:
type: string
enum:
- all_credit
- all_transaction
- credit_first
@@ -26244,10 +26287,11 @@
enum:
- bacs
- ach
- amazon
- apple_pay
+ - braintree_apple_pay
- check
- credit_card
- eft
- google_pay
- money_order
@@ -26437,9 +26481,10 @@
- bacs
- amazon
- amazon_billing_agreement
- apple_pay
- bank_account_info
+ - braintree_apple_pay
- check
- credit_card
- eft
- gateway_token
- google_pay