Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Oct 4, 2023
1 parent 52f9ca0 commit c98f478
Show file tree
Hide file tree
Showing 6 changed files with 320 additions and 562 deletions.
153 changes: 55 additions & 98 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27592,29 +27592,6 @@
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"margins": {
"description": "The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.",
"items": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/margin"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/margin"
}
]
}
},
"nullable": true,
"type": "array"
},
"metadata": {
"additionalProperties": {
"maxLength": 500,
Expand Down Expand Up @@ -27747,7 +27724,6 @@
"discounts",
"id",
"livemode",
"margins",
"metadata",
"object",
"period",
Expand All @@ -27766,7 +27742,6 @@
"discount_amounts",
"discounts",
"invoice_item",
"margins",
"period",
"plan",
"price",
Expand Down Expand Up @@ -28396,78 +28371,6 @@
"in_package": ""
}
},
"margin": {
"description": "A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who\nresell products and services and earn a discount (margin) for doing so.",
"properties": {
"active": {
"description": "Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.",
"type": "boolean"
},
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"metadata": {
"additionalProperties": {
"maxLength": 500,
"type": "string"
},
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"nullable": true,
"type": "object"
},
"name": {
"description": "Name of the margin that's displayed on, for example, invoices.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"margin"
],
"type": "string"
},
"percent_off": {
"description": "Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.",
"type": "number"
},
"updated": {
"description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
}
},
"required": [
"active",
"created",
"id",
"livemode",
"metadata",
"name",
"object",
"percent_off",
"updated"
],
"title": "Margin",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Margin",
"in_package": ""
}
},
"migrate_to": {
"description": "",
"properties": {
Expand Down Expand Up @@ -33787,12 +33690,26 @@
],
"nullable": true,
"type": "string"
},
"statement_descriptor": {
"description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"statement_descriptor_suffix": {
"description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"required": [
"capture_method",
"metadata",
"setup_future_usage"
"setup_future_usage",
"statement_descriptor",
"statement_descriptor_suffix"
],
"title": "PaymentLinksResourcePaymentIntentData",
"type": "object",
Expand Down Expand Up @@ -123522,6 +123439,16 @@
"on_session"
],
"type": "string"
},
"statement_descriptor": {
"description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
"description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
"maxLength": 22,
"type": "string"
}
},
"title": "payment_intent_data_params",
Expand Down Expand Up @@ -124594,6 +124521,36 @@
}
],
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents] (/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."
},
"statement_descriptor": {
"anyOf": [
{
"maxLength": 22,
"type": "string"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge."
},
"statement_descriptor_suffix": {
"anyOf": [
{
"maxLength": 22,
"type": "string"
},
{
"enum": [
""
],
"type": "string"
}
],
"description": "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."
}
},
"title": "payment_intent_data_update_params",
Expand Down
Loading

0 comments on commit c98f478

Please sign in to comment.