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 Jul 30, 2024
1 parent 8daa8c2 commit 75a8388
Show file tree
Hide file tree
Showing 2 changed files with 226 additions and 0 deletions.
124 changes: 124 additions & 0 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12819,6 +12819,22 @@
"type": "customer.subscription.pending_update_expired"
}
},
"customer.subscription.price_migration_failed": {
"description": "Occurs whenever a price migration failed to transition prices on a subscription.",
"properties": {
"object": {
"$ref": "#/components/schemas/subscription"
}
},
"required": [
"object"
],
"type": "object",
"x-expandableFields": [],
"x-stripeEvent": {
"type": "customer.subscription.price_migration_failed"
}
},
"customer.subscription.resumed": {
"description": "Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed.",
"properties": {
Expand Down Expand Up @@ -16868,6 +16884,7 @@
"customer.subscription.paused",
"customer.subscription.pending_update_applied",
"customer.subscription.pending_update_expired",
"customer.subscription.price_migration_failed",
"customer.subscription.resumed",
"customer.subscription.trial_will_end",
"customer.subscription.updated",
Expand Down Expand Up @@ -17004,6 +17021,7 @@
"subscription_schedule.completed",
"subscription_schedule.created",
"subscription_schedule.expiring",
"subscription_schedule.price_migration_failed",
"subscription_schedule.released",
"subscription_schedule.updated",
"tax.form.updated",
Expand Down Expand Up @@ -52920,6 +52938,15 @@
"maxLength": 5000,
"type": "string"
},
"last_price_migration_error": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_resource_price_migration_error"
}
],
"description": "Details of the most recent price migration that failed for the subscription schedule.",
"nullable": true
},
"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"
Expand Down Expand Up @@ -53049,6 +53076,7 @@
"current_phase",
"customer",
"default_settings",
"last_price_migration_error",
"phases",
"prebilling",
"subscription",
Expand Down Expand Up @@ -61024,6 +61052,15 @@
"data"
]
},
"last_price_migration_error": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_resource_price_migration_error"
}
],
"description": "Details of the most recent price migration that failed for the subscription.",
"nullable": true
},
"latest_invoice": {
"anyOf": [
{
Expand Down Expand Up @@ -61307,6 +61344,7 @@
"discounts",
"invoice_settings",
"items",
"last_price_migration_error",
"latest_invoice",
"on_behalf_of",
"pause_collection",
Expand Down Expand Up @@ -61875,6 +61913,15 @@
"maxLength": 5000,
"type": "string"
},
"last_price_migration_error": {
"anyOf": [
{
"$ref": "#/components/schemas/subscriptions_resource_price_migration_error"
}
],
"description": "Details of the most recent price migration that failed for the subscription schedule.",
"nullable": true
},
"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"
Expand Down Expand Up @@ -62002,6 +62049,7 @@
"current_phase",
"customer",
"default_settings",
"last_price_migration_error",
"phases",
"prebilling",
"subscription",
Expand Down Expand Up @@ -62145,6 +62193,22 @@
"type": "subscription_schedule.expiring"
}
},
"subscription_schedule.price_migration_failed": {
"description": "Occurs whenever a price migration failed to transition prices on a subscription schedule.",
"properties": {
"object": {
"$ref": "#/components/schemas/subscription_schedule"
}
},
"required": [
"object"
],
"type": "object",
"x-expandableFields": [],
"x-stripeEvent": {
"type": "subscription_schedule.price_migration_failed"
}
},
"subscription_schedule.released": {
"description": "Occurs whenever a new subscription schedule is released.",
"properties": {
Expand Down Expand Up @@ -63166,6 +63230,62 @@
"subscription_items"
]
},
"subscriptions_resource_price_migration_error": {
"description": "",
"properties": {
"errored_at": {
"description": "The time at which the price migration encountered an error.",
"format": "unix-time",
"type": "integer"
},
"failed_transitions": {
"description": "The involved price pairs in each failed transition.",
"items": {
"$ref": "#/components/schemas/subscriptions_resource_price_migration_error_failed_transition"
},
"type": "array"
},
"type": {
"description": "The type of error encountered by the price migration.",
"enum": [
"price_uniqueness_violation"
],
"type": "string"
}
},
"required": [
"errored_at",
"failed_transitions",
"type"
],
"title": "SubscriptionsResourcePriceMigrationError",
"type": "object",
"x-expandableFields": [
"failed_transitions"
]
},
"subscriptions_resource_price_migration_error_failed_transition": {
"description": "",
"properties": {
"source_price": {
"description": "The original price to be migrated.",
"maxLength": 5000,
"type": "string"
},
"target_price": {
"description": "The intended resulting price of the migration.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"source_price",
"target_price"
],
"title": "SubscriptionsResourcePriceMigrationErrorFailedTransition",
"type": "object",
"x-expandableFields": []
},
"subscriptions_resource_subscription_invoice_settings": {
"description": "",
"properties": {
Expand Down Expand Up @@ -211277,6 +211397,7 @@
"customer.subscription.paused",
"customer.subscription.pending_update_applied",
"customer.subscription.pending_update_expired",
"customer.subscription.price_migration_failed",
"customer.subscription.resumed",
"customer.subscription.trial_will_end",
"customer.subscription.updated",
Expand Down Expand Up @@ -211413,6 +211534,7 @@
"subscription_schedule.completed",
"subscription_schedule.created",
"subscription_schedule.expiring",
"subscription_schedule.price_migration_failed",
"subscription_schedule.released",
"subscription_schedule.updated",
"tax.form.updated",
Expand Down Expand Up @@ -211790,6 +211912,7 @@
"customer.subscription.paused",
"customer.subscription.pending_update_applied",
"customer.subscription.pending_update_expired",
"customer.subscription.price_migration_failed",
"customer.subscription.resumed",
"customer.subscription.trial_will_end",
"customer.subscription.updated",
Expand Down Expand Up @@ -211926,6 +212049,7 @@
"subscription_schedule.completed",
"subscription_schedule.created",
"subscription_schedule.expiring",
"subscription_schedule.price_migration_failed",
"subscription_schedule.released",
"subscription_schedule.updated",
"tax.form.updated",
Expand Down
Loading

0 comments on commit 75a8388

Please sign in to comment.