diff --git a/openapi/api.yaml b/openapi/api.yaml index 79338fca..cdfd7bdf 100644 --- a/openapi/api.yaml +++ b/openapi/api.yaml @@ -8982,10 +8982,11 @@ paths: summary: Refund an invoice description: | There are two ways to do a refund: - * refund a specific amount which is divided across all the line items. - * refund quantities of line items. - If you want to refund the entire refundable amount on the invoice, the - simplest way is to do `type=amount` without specifiying an `amount`. + * Apply a specific dollar/cent amount or percentage amount to an entire invoice, which will refund the resulting amount across all line items on the invoice. + * If you want to refund the entire refundable amount on the invoice, the simplest way is to do `type=amount` without specifiying an `amount`. + * Note: You must have the Credit Memos feature flag enabled on your site to utilize percentage amount refunds on invoices. + * Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund. + * Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items. parameters: - "$ref": "#/components/parameters/site_id" - "$ref": "#/components/parameters/invoice_id" @@ -16128,11 +16129,14 @@ components: 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? @@ -16339,14 +16343,14 @@ components: 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 @@ -16472,14 +16476,14 @@ components: 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? @@ -16670,8 +16674,7 @@ components: maxLength: 50 gateway_code: type: string - title: An identifier for a specific payment gateway. Must be used in conjunction - with `gateway_token`. + title: An identifier for a specific payment gateway. maxLength: 12 gateway_attributes: type: object @@ -17678,11 +17681,13 @@ components: 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? @@ -17767,11 +17772,13 @@ components: 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? @@ -17844,11 +17851,13 @@ components: 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? @@ -18721,11 +18730,13 @@ components: 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" proration_rate: @@ -18928,13 +18939,13 @@ components: 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 @@ -19156,11 +19167,13 @@ components: 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? @@ -19345,13 +19358,13 @@ components: 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? @@ -19561,13 +19574,13 @@ components: 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? @@ -20992,7 +21005,7 @@ components: type: string format: date-time title: Start date - description: If set, the subscription will begin in the future on this date. + description: If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. next_bill_date: @@ -21080,6 +21093,12 @@ components: mail order and telephone transactions. enum: - moto + bulk: + type: boolean + description: Optional field to be used only when needing to bypass the 60 + second limit on creating subscriptions. Should only be used when creating + subscriptions in bulk from the API. + default: false required: - plan_code - currency @@ -21141,7 +21160,7 @@ components: type: string format: date-time title: Start date - description: If set, the subscription will begin in the future on this date. + description: If set, the subscription will begin on this specified date. The subscription will apply the setup fee and trial period, unless the plan has no trial. next_bill_date: @@ -21187,6 +21206,12 @@ components: description: The new set of ramp intervals for the subscription. items: "$ref": "#/components/schemas/SubscriptionRampInterval" + bulk: + type: boolean + description: Optional field to be used only when needing to bypass the 60 + second limit on creating subscriptions. Should only be used when creating + subscriptions in bulk from the API. + default: false required: - plan_code SubscriptionUpdate: diff --git a/recurly/resources.py b/recurly/resources.py index 4bdb8bff..16efcb51 100644 --- a/recurly/resources.py +++ b/recurly/resources.py @@ -1452,7 +1452,7 @@ class LineItem(Resource): tax : float The tax amount for the line item. tax_code : str - 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`. + 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 : bool `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature. tax_inclusive : bool @@ -2187,7 +2187,7 @@ class Item(Resource): state : str The current state of the item. tax_code : str - 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`. + 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 : bool `true` exempts tax on the item, `false` applies tax on the item. updated_at : datetime @@ -2341,7 +2341,7 @@ class Plan(Resource): state : str The current state of the plan. tax_code : str - 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`. + 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 : bool `true` exempts tax on the plan, `false` applies tax on the plan. total_billing_cycles : int @@ -2512,7 +2512,7 @@ class AddOn(Resource): state : str Add-ons can be either active or inactive. tax_code : str - 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`. + 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. tier_type : str The type of tiering used by the Add-on. tiers : :obj:`list` of :obj:`Tier`