Skip to content

Commit

Permalink
OpenAPI Update (#736)
Browse files Browse the repository at this point in the history 
Update OpenAPI for 487814e0fb4ade658c2c08caa8491bcb032a0e2b

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Mar 29, 2024
1 parent a1291e6 commit dca9e02
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 45 deletions.
60 changes: 30 additions & 30 deletions embedded/openapi/spec3.beta.sdk.json
View file
Expand Up @@ -86166,13 +86166,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -92101,13 +92101,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -92889,13 +92889,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -103470,13 +103470,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -104427,7 +104427,7 @@
},
"/v1/invoices/create_preview": {
"post": {
"description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a <code>proration_date</code> parameter when doing the actual subscription update. The value passed in should be the same as the <code>subscription_proration_date</code> returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_proration_date</code> on the upcoming invoice resource.</p>",
"description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_details.proration_date</code> value passed in the request.</p>",
"operationId": "PostInvoicesCreatePreview",
"requestBody": {
"content": {
Expand Down Expand Up @@ -107317,7 +107317,7 @@
},
"/v1/invoices/upcoming": {
"get": {
"description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a <code>proration_date</code> parameter when doing the actual subscription update. The value passed in should be the same as the <code>subscription_proration_date</code> returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_proration_date</code> on the upcoming invoice resource.</p>",
"description": "<p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.</p>\n\n<p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>\n\n<p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_proration_date</code> value passed in the request.</p>",
"operationId": "GetInvoicesUpcoming",
"parameters": [
{
Expand Down Expand Up @@ -114232,13 +114232,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -146435,13 +146435,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down Expand Up @@ -147714,13 +147714,13 @@
"items": {
"properties": {
"name": {
"description": "The name of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The name of the custom field. This may be up to 40 characters.",
"maxLength": 40,
"type": "string"
},
"value": {
"description": "The value of the custom field. This may be up to 30 characters.",
"maxLength": 30,
"description": "The value of the custom field. This may be up to 140 characters.",
"maxLength": 140,
"type": "string"
}
},
Expand Down

0 comments on commit dca9e02

Please sign in to comment.