openapi/api.yaml in recurly-3.21.0 vs openapi/api.yaml in recurly-3.22.0

- old
+ new

@@ -14461,10 +14461,12 @@ application/json: schema: "$ref": "#/components/schemas/Error" x-code-samples: [] "/dunning_campaigns/{dunning_campaign_id}/bulk_update": + parameters: + - "$ref": "#/components/parameters/dunning_campaign_id" put: tags: - dunning_campaigns operationId: put_dunning_campaign_bulk_update summary: Assign a dunning campaign to multiple plans @@ -18421,10 +18423,18 @@ type: integer title: Quantity description: This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes. default: 1 + 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. unit_amount: type: number format: float title: Unit amount description: Positive amount for a charge, negative amount for a credit. @@ -18501,10 +18511,17 @@ refunded_quantity: type: integer title: Refunded Quantity description: For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). + refunded_quantity_decimal: + type: string + title: Refunded Quantity Decimal + description: A floating-point alternative to Refunded Quantity. For refund + charges, the quantity being refunded. For non-refund charges, the total + quantity refunded (possibly over multiple refunds). The Decimal Quantity + feature must be enabled to utilize this field. credit_applied: type: number format: float title: Credit Applied description: The amount of credit from this line item that was applied to @@ -18542,10 +18559,18 @@ maxLength: 13 quantity: type: integer title: Quantity description: Line item quantity to be refunded. + 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. prorate: type: boolean title: Prorate description: | Set to `true` if the line item should be prorated; set to `false` if not. @@ -19333,11 +19358,11 @@ type: object title: Plan Ramp Interval properties: starting_billing_cycle: type: integer - description: Represents the first billing cycle of a ramp. + description: Represents the billing cycle where a ramp interval starts. default: 1 currencies: type: array description: Represents the price for the ramp interval. items: @@ -21091,22 +21116,22 @@ type: object title: Subscription Ramp Interval properties: starting_billing_cycle: type: integer - description: Represents how many billing cycles are included in a ramp interval. + description: Represents the billing cycle where a ramp interval starts. default: 1 unit_amount: type: integer description: Represents the price for the ramp interval. SubscriptionRampIntervalResponse: type: object title: Subscription Ramp Interval properties: starting_billing_cycle: type: integer - description: Represents how many billing cycles are included in a ramp interval. + description: Represents the billing cycle where a ramp interval starts. remaining_billing_cycles: type: integer description: Represents how many billing cycles are left in a ramp interval. unit_amount: type: integer @@ -21531,14 +21556,15 @@ with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint. amount: type: number format: float - description: The amount of usage. Can be positive, negative, or 0. No decimals - allowed, we will strip them. If the usage-based add-on is billed with - a percentage, your usage will be a monetary amount you will want to format - in cents. (e.g., $5.00 is "500"). + description: The amount of usage. Can be positive, negative, or 0. If the + Decimal Quantity feature is enabled, this value will be rounded to nine + decimal places. Otherwise, all digits after the decimal will be stripped. + If the usage-based add-on is billed with a percentage, your usage should + be a monetary amount formatted in cents (e.g., $5.00 is "500"). usage_type: type: string enum: - price - percentage @@ -21607,13 +21633,14 @@ with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint. amount: type: number format: float - description: The amount of usage. Can be positive, negative, or 0. No decimals - allowed, we will strip them. If the usage-based add-on is billed with - a percentage, your usage will be a monetary amount you will want to format - in cents. (e.g., $5.00 is "500"). + description: The amount of usage. Can be positive, negative, or 0. If the + Decimal Quantity feature is enabled, this value will be rounded to nine + decimal places. Otherwise, all digits after the decimal will be stripped. + If the usage-based add-on is billed with a percentage, your usage should + be a monetary amount formatted in cents (e.g., $5.00 is "500"). recording_timestamp: type: string format: date-time description: When the usage was recorded in your system. usage_timestamp: