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 Aug 22, 2023
1 parent 649f667 commit 39b0d2f
Show file tree
Hide file tree
Showing 6 changed files with 496 additions and 6 deletions.
101 changes: 100 additions & 1 deletion openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38062,6 +38062,26 @@
"in_package": ""
}
},
"portal_flows_coupon_offer": {
"description": "",
"properties": {
"coupon": {
"description": "The ID of the coupon to be offered.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"coupon"
],
"title": "PortalFlowsCouponOffer",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CouponOffer",
"in_package": ""
}
},
"portal_flows_flow": {
"description": "",
"properties": {
Expand Down Expand Up @@ -38176,18 +38196,30 @@
"portal_flows_flow_subscription_cancel": {
"description": "",
"properties": {
"retention": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_retention"
}
],
"description": "Specify a retention strategy to be used in the cancellation flow.",
"nullable": true
},
"subscription": {
"description": "The ID of the subscription to be canceled.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"retention",
"subscription"
],
"title": "PortalFlowsFlowSubscriptionCancel",
"type": "object",
"x-expandableFields": [],
"x-expandableFields": [
"retention"
],
"x-stripeResource": {
"class_name": "SubscriptionCancel",
"in_package": ""
Expand Down Expand Up @@ -38253,6 +38285,40 @@
"in_package": ""
}
},
"portal_flows_retention": {
"description": "",
"properties": {
"coupon_offer": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_coupon_offer"
}
],
"description": "Configuration when `retention.type=coupon_offer`.",
"nullable": true
},
"type": {
"description": "Type of retention strategy that will be used.",
"enum": [
"coupon_offer"
],
"type": "string"
}
},
"required": [
"coupon_offer",
"type"
],
"title": "PortalFlowsRetention",
"type": "object",
"x-expandableFields": [
"coupon_offer"
],
"x-stripeResource": {
"class_name": "Retention",
"in_package": ""
}
},
"portal_flows_subscription_update_confirm_discount": {
"description": "",
"properties": {
Expand Down Expand Up @@ -67939,6 +68005,39 @@
"subscription_cancel": {
"description": "Configuration when `flow_data.type=subscription_cancel`.",
"properties": {
"retention": {
"description": "Specify a retention strategy to be used in the cancellation flow.",
"properties": {
"coupon_offer": {
"description": "Configuration when `retention.type=coupon_offer`.",
"properties": {
"coupon": {
"description": "The ID of the coupon to be offered.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"coupon"
],
"title": "coupon_offer_param",
"type": "object"
},
"type": {
"description": "Type of retention strategy to use with the customer.",
"enum": [
"coupon_offer"
],
"type": "string"
}
},
"required": [
"coupon_offer",
"type"
],
"title": "retention_param",
"type": "object"
},
"subscription": {
"description": "The ID of the subscription to be canceled.",
"maxLength": 5000,
Expand Down
77 changes: 76 additions & 1 deletion openapi/spec3.beta.sdk.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35132,6 +35132,21 @@ components:
x-stripeResource:
class_name: Redirect
in_package: ''
portal_flows_coupon_offer:
description: ''
properties:
coupon:
description: The ID of the coupon to be offered.
maxLength: 5000
type: string
required:
- coupon
title: PortalFlowsCouponOffer
type: object
x-expandableFields: []
x-stripeResource:
class_name: CouponOffer
in_package: ''
portal_flows_flow:
description: ''
properties:
Expand Down Expand Up @@ -35213,15 +35228,22 @@ components:
portal_flows_flow_subscription_cancel:
description: ''
properties:
retention:
anyOf:
- $ref: '#/components/schemas/portal_flows_retention'
description: Specify a retention strategy to be used in the cancellation flow.
nullable: true
subscription:
description: The ID of the subscription to be canceled.
maxLength: 5000
type: string
required:
- retention
- subscription
title: PortalFlowsFlowSubscriptionCancel
type: object
x-expandableFields: []
x-expandableFields:
- retention
x-stripeResource:
class_name: SubscriptionCancel
in_package: ''
Expand Down Expand Up @@ -35277,6 +35299,29 @@ components:
x-stripeResource:
class_name: SubscriptionUpdateConfirm
in_package: ''
portal_flows_retention:
description: ''
properties:
coupon_offer:
anyOf:
- $ref: '#/components/schemas/portal_flows_coupon_offer'
description: Configuration when `retention.type=coupon_offer`.
nullable: true
type:
description: Type of retention strategy that will be used.
enum:
- coupon_offer
type: string
required:
- coupon_offer
- type
title: PortalFlowsRetention
type: object
x-expandableFields:
- coupon_offer
x-stripeResource:
class_name: Retention
in_package: ''
portal_flows_subscription_update_confirm_discount:
description: ''
properties:
Expand Down Expand Up @@ -61681,6 +61726,36 @@ paths:
subscription_cancel:
description: Configuration when `flow_data.type=subscription_cancel`.
properties:
retention:
description: >-
Specify a retention strategy to be used in the
cancellation flow.
properties:
coupon_offer:
description: >-
Configuration when
`retention.type=coupon_offer`.
properties:
coupon:
description: The ID of the coupon to be offered.
maxLength: 5000
type: string
required:
- coupon
title: coupon_offer_param
type: object
type:
description: >-
Type of retention strategy to use with the
customer.
enum:
- coupon_offer
type: string
required:
- coupon_offer
- type
title: retention_param
type: object
subscription:
description: The ID of the subscription to be canceled.
maxLength: 5000
Expand Down
87 changes: 86 additions & 1 deletion openapi/spec3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28534,6 +28534,22 @@
"type": "object",
"x-expandableFields": []
},
"portal_flows_coupon_offer": {
"description": "",
"properties": {
"coupon": {
"description": "The ID of the coupon to be offered.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"coupon"
],
"title": "PortalFlowsCouponOffer",
"type": "object",
"x-expandableFields": []
},
"portal_flows_flow": {
"description": "",
"properties": {
Expand Down Expand Up @@ -28635,6 +28651,15 @@
"portal_flows_flow_subscription_cancel": {
"description": "",
"properties": {
"retention": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_retention"
}
],
"description": "Specify a retention strategy to be used in the cancellation flow.",
"nullable": true
},
"subscription": {
"description": "The ID of the subscription to be canceled.",
"maxLength": 5000,
Expand All @@ -28646,7 +28671,9 @@
],
"title": "PortalFlowsFlowSubscriptionCancel",
"type": "object",
"x-expandableFields": []
"x-expandableFields": [
"retention"
]
},
"portal_flows_flow_subscription_update": {
"description": "",
Expand Down Expand Up @@ -28699,6 +28726,35 @@
"items"
]
},
"portal_flows_retention": {
"description": "",
"properties": {
"coupon_offer": {
"anyOf": [
{
"$ref": "#/components/schemas/portal_flows_coupon_offer"
}
],
"description": "Configuration when `retention.type=coupon_offer`.",
"nullable": true
},
"type": {
"description": "Type of retention strategy that will be used.",
"enum": [
"coupon_offer"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "PortalFlowsRetention",
"type": "object",
"x-expandableFields": [
"coupon_offer"
]
},
"portal_flows_subscription_update_confirm_discount": {
"description": "",
"properties": {
Expand Down Expand Up @@ -53086,6 +53142,35 @@
},
"subscription_cancel": {
"properties": {
"retention": {
"properties": {
"coupon_offer": {
"properties": {
"coupon": {
"maxLength": 5000,
"type": "string"
}
},
"required": [
"coupon"
],
"title": "coupon_offer_param",
"type": "object"
},
"type": {
"enum": [
"coupon_offer"
],
"type": "string"
}
},
"required": [
"coupon_offer",
"type"
],
"title": "retention_param",
"type": "object"
},
"subscription": {
"maxLength": 5000,
"type": "string"
Expand Down
Loading

0 comments on commit 39b0d2f

Please sign in to comment.