Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

OpenAPI Update #890

Merged
merged 1 commit into from
Jun 28, 2024
Merged

OpenAPI Update #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions embedded/openapi/spec3.beta.sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13432,10 +13432,10 @@
}
},
"customer_session": {
"description": "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer.",
"description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
"properties": {
"client_secret": {
"description": "The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
"maxLength": 5000,
"type": "string"
},
Expand All @@ -13457,7 +13457,7 @@
"$ref": "#/components/schemas/customer"
}
],
"description": "The customer the customer session was created for.",
"description": "The Customer the Customer Session was created for.",
"x-expansionResources": {
"oneOf": [
{
Expand All @@ -13467,7 +13467,7 @@
}
},
"expires_at": {
"description": "The timestamp at which this customer session will expire.",
"description": "The timestamp at which this Customer Session will expire.",
"format": "unix-time",
"type": "integer"
},
Expand Down Expand Up @@ -13513,7 +13513,7 @@
}
},
"customer_session_resource_components": {
"description": "Configuration for the components supported by this customer session.",
"description": "Configuration for the components supported by this Customer Session.",
"properties": {
"buy_button": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
Expand Down Expand Up @@ -13553,10 +13553,10 @@
"x-expandableFields": []
},
"customer_session_resource_components_resource_payment_element": {
"description": "This hash contains whether the payment element is enabled and the features it supports.",
"description": "This hash contains whether the Payment Element is enabled and the features it supports.",
"properties": {
"enabled": {
"description": "Whether the payment element is enabled.",
"description": "Whether the Payment Element is enabled.",
"type": "boolean"
},
"features": {
Expand All @@ -13565,7 +13565,7 @@
"$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features"
}
],
"description": "This hash defines whether the payment element supports certain features.",
"description": "This hash defines whether the Payment Element supports certain features.",
"nullable": true
}
},
Expand All @@ -13583,7 +13583,7 @@
"description": "This hash contains the features the Payment Element supports.",
"properties": {
"payment_method_remove": {
"description": "Controls whether the Payment Element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"enum": [
"disabled",
"enabled"
Expand All @@ -13592,7 +13592,7 @@
"x-stripeBypassValidation": true
},
"payment_method_save": {
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"enum": [
"disabled",
"enabled"
Expand All @@ -13601,7 +13601,7 @@
"x-stripeBypassValidation": true
},
"payment_method_update": {
"description": "Controls whether the Payment Element displays the option to update a saved payment method.",
"description": "Controls whether the Payment Element displays the option to update a saved payment method. This parameter defaults to `disabled`.",
"enum": [
"disabled",
"enabled"
Expand Down Expand Up @@ -94624,7 +94624,7 @@
},
"/v1/customer_sessions": {
"post": {
"description": "<p>Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.</p>",
"description": "<p>Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.</p>",
"operationId": "PostCustomerSessions",
"requestBody": {
"content": {
Expand Down Expand Up @@ -94660,17 +94660,17 @@
"type": "object"
},
"payment_element": {
"description": "Configuration for the payment element.",
"description": "Configuration for the Payment Element.",
"properties": {
"enabled": {
"description": "Whether the payment element is enabled.",
"description": "Whether the Payment Element is enabled.",
"type": "boolean"
},
"features": {
"description": "This hash defines whether the payment element supports certain features.",
"description": "This hash defines whether the Payment Element supports certain features.",
"properties": {
"payment_method_remove": {
"description": "Controls whether the Payment Element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
"enum": [
"disabled",
"enabled"
Expand All @@ -94679,7 +94679,7 @@
"x-stripeBypassValidation": true
},
"payment_method_save": {
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
"enum": [
"disabled",
"enabled"
Expand All @@ -94688,7 +94688,7 @@
"x-stripeBypassValidation": true
},
"payment_method_update": {
"description": "Controls whether the Payment Element displays the option to update a saved payment method.",
"description": "Controls whether the Payment Element displays the option to update a saved payment method. This parameter defaults to `disabled`.",
"enum": [
"disabled",
"enabled"
Expand Down Expand Up @@ -94726,7 +94726,7 @@
"type": "object"
},
"customer": {
"description": "The ID of an existing customer for which to create the customer session.",
"description": "The ID of an existing customer for which to create the Customer Session.",
"maxLength": 5000,
"type": "string"
},
Expand Down
14 changes: 7 additions & 7 deletions embedded/openapi/spec3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9419,10 +9419,10 @@
"x-resourceId": "customer_cash_balance_transaction"
},
"customer_session": {
"description": "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer.",
"description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.",
"properties": {
"client_secret": {
"description": "The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
"description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.",
"maxLength": 5000,
"type": "string"
},
Expand All @@ -9444,7 +9444,7 @@
"$ref": "#/components/schemas/customer"
}
],
"description": "The customer the customer session was created for.",
"description": "The Customer the Customer Session was created for.",
"x-expansionResources": {
"oneOf": [
{
Expand All @@ -9454,7 +9454,7 @@
}
},
"expires_at": {
"description": "The timestamp at which this customer session will expire.",
"description": "The timestamp at which this Customer Session will expire.",
"format": "unix-time",
"type": "integer"
},
Expand Down Expand Up @@ -9487,7 +9487,7 @@
"x-resourceId": "customer_session"
},
"customer_session_resource_components": {
"description": "Configuration for the components supported by this customer session.",
"description": "Configuration for the components supported by this Customer Session.",
"properties": {
"buy_button": {
"$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
Expand Down Expand Up @@ -71239,7 +71239,7 @@
},
"/v1/customer_sessions": {
"post": {
"description": "<p>Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.</p>",
"description": "<p>Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.</p>",
"operationId": "PostCustomerSessions",
"requestBody": {
"content": {
Expand Down Expand Up @@ -71289,7 +71289,7 @@
"type": "object"
},
"customer": {
"description": "The ID of an existing customer for which to create the customer session.",
"description": "The ID of an existing customer for which to create the Customer Session.",
"maxLength": 5000,
"type": "string"
},
Expand Down
Loading