From 24b39489b13553826270db165abd2882378b3979 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:11:17 +0000 Subject: [PATCH] Update OpenAPI specification --- openapi/spec3.beta.sdk.json | 4 +-- openapi/spec3.beta.sdk.yaml | 62 ++++++++++++++++++++++++------------- openapi/spec3.json | 2 +- openapi/spec3.sdk.json | 2 +- openapi/spec3.sdk.yaml | 31 ++++++++++++------- openapi/spec3.yaml | 31 ++++++++++++------- 6 files changed, 84 insertions(+), 48 deletions(-) diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index 1b0adc02..5a4ea541 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -15397,7 +15397,7 @@ "$ref": "#/components/schemas/automatic_tax" }, "billing_reason": { - "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.", + "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", @@ -40646,7 +40646,7 @@ "$ref": "#/components/schemas/automatic_tax" }, "billing_reason": { - "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.", + "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index 7669aeca..7accc708 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -14418,17 +14418,26 @@ components: billing_reason: description: >- Indicates the reason why the invoice was created. - `subscription_cycle` indicates an invoice created by a subscription - advancing into a new period. `subscription_create` indicates an - invoice created due to creating a subscription. - `subscription_update` indicates an invoice created due to updating a - subscription. `subscription` is set for all old invoices to indicate - either a change to a subscription or a period advancement. `manual` - is set for all invoices unrelated to a subscription (for example: - created via the invoice editor). The `upcoming` value is reserved - for simulated invoices per the upcoming invoice endpoint. - `subscription_threshold` indicates an invoice created due to a - billing threshold being reached. + + + * `manual`: Unrelated to a subscription, for example, created via + the invoice editor. + + * `subscription`: No longer in use. Applies to subscriptions from + before May 2018 where no distinction was made between updates, + cycles, and thresholds. + + * `subscription_create`: A new subscription was created. + + * `subscription_cycle`: A subscription advanced into a new period. + + * `subscription_threshold`: A subscription reached a billing + threshold. + + * `subscription_update`: A subscription was updated. + + * `upcoming`: Reserved for simulated invoices, per the upcoming + invoice endpoint. enum: - automatic_pending_invoice_item_invoice - manual @@ -37395,17 +37404,26 @@ components: billing_reason: description: >- Indicates the reason why the invoice was created. - `subscription_cycle` indicates an invoice created by a subscription - advancing into a new period. `subscription_create` indicates an - invoice created due to creating a subscription. - `subscription_update` indicates an invoice created due to updating a - subscription. `subscription` is set for all old invoices to indicate - either a change to a subscription or a period advancement. `manual` - is set for all invoices unrelated to a subscription (for example: - created via the invoice editor). The `upcoming` value is reserved - for simulated invoices per the upcoming invoice endpoint. - `subscription_threshold` indicates an invoice created due to a - billing threshold being reached. + + + * `manual`: Unrelated to a subscription, for example, created via + the invoice editor. + + * `subscription`: No longer in use. Applies to subscriptions from + before May 2018 where no distinction was made between updates, + cycles, and thresholds. + + * `subscription_create`: A new subscription was created. + + * `subscription_cycle`: A subscription advanced into a new period. + + * `subscription_threshold`: A subscription reached a billing + threshold. + + * `subscription_update`: A subscription was updated. + + * `upcoming`: Reserved for simulated invoices, per the upcoming + invoice endpoint. enum: - automatic_pending_invoice_item_invoice - manual diff --git a/openapi/spec3.json b/openapi/spec3.json index 713b12da..35f7d784 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -11195,7 +11195,7 @@ "$ref": "#/components/schemas/automatic_tax" }, "billing_reason": { - "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.", + "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json index 8e9d82eb..b107e122 100644 --- a/openapi/spec3.sdk.json +++ b/openapi/spec3.sdk.json @@ -13646,7 +13646,7 @@ "$ref": "#/components/schemas/automatic_tax" }, "billing_reason": { - "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.", + "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.", "enum": [ "automatic_pending_invoice_item_invoice", "manual", diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml index d2b6cafa..b26645e7 100644 --- a/openapi/spec3.sdk.yaml +++ b/openapi/spec3.sdk.yaml @@ -12799,17 +12799,26 @@ components: billing_reason: description: >- Indicates the reason why the invoice was created. - `subscription_cycle` indicates an invoice created by a subscription - advancing into a new period. `subscription_create` indicates an - invoice created due to creating a subscription. - `subscription_update` indicates an invoice created due to updating a - subscription. `subscription` is set for all old invoices to indicate - either a change to a subscription or a period advancement. `manual` - is set for all invoices unrelated to a subscription (for example: - created via the invoice editor). The `upcoming` value is reserved - for simulated invoices per the upcoming invoice endpoint. - `subscription_threshold` indicates an invoice created due to a - billing threshold being reached. + + + * `manual`: Unrelated to a subscription, for example, created via + the invoice editor. + + * `subscription`: No longer in use. Applies to subscriptions from + before May 2018 where no distinction was made between updates, + cycles, and thresholds. + + * `subscription_create`: A new subscription was created. + + * `subscription_cycle`: A subscription advanced into a new period. + + * `subscription_threshold`: A subscription reached a billing + threshold. + + * `subscription_update`: A subscription was updated. + + * `upcoming`: Reserved for simulated invoices, per the upcoming + invoice endpoint. enum: - automatic_pending_invoice_item_invoice - manual diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml index da576115..bd5a2c4a 100644 --- a/openapi/spec3.yaml +++ b/openapi/spec3.yaml @@ -10854,17 +10854,26 @@ components: billing_reason: description: >- Indicates the reason why the invoice was created. - `subscription_cycle` indicates an invoice created by a subscription - advancing into a new period. `subscription_create` indicates an - invoice created due to creating a subscription. - `subscription_update` indicates an invoice created due to updating a - subscription. `subscription` is set for all old invoices to indicate - either a change to a subscription or a period advancement. `manual` - is set for all invoices unrelated to a subscription (for example: - created via the invoice editor). The `upcoming` value is reserved - for simulated invoices per the upcoming invoice endpoint. - `subscription_threshold` indicates an invoice created due to a - billing threshold being reached. + + + * `manual`: Unrelated to a subscription, for example, created via + the invoice editor. + + * `subscription`: No longer in use. Applies to subscriptions from + before May 2018 where no distinction was made between updates, + cycles, and thresholds. + + * `subscription_create`: A new subscription was created. + + * `subscription_cycle`: A subscription advanced into a new period. + + * `subscription_threshold`: A subscription reached a billing + threshold. + + * `subscription_update`: A subscription was updated. + + * `upcoming`: Reserved for simulated invoices, per the upcoming + invoice endpoint. enum: - automatic_pending_invoice_item_invoice - manual