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

OpenAPI Update #762

Merged
merged 1 commit into from
Apr 22, 2024
Merged

OpenAPI Update #762

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
3 changes: 2 additions & 1 deletion embedded/openapi/fixtures3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1839,7 +1839,8 @@
"status": "verified",
"type": "document",
"url": null,
"verified_outputs": null
"verified_outputs": null,
"provided_details": null
},
"invoice": {
"account_country": "US",
Expand Down
90 changes: 90 additions & 0 deletions embedded/openapi/spec3.beta.sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49305,6 +49305,15 @@
"nullable": true,
"type": "string"
},
"cancel_subscription_schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/quotes_resource_quote_lines_cancel_subscription_schedule"
}
],
"description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for metadata modifications.",
"nullable": true
},
"ends_at": {
"anyOf": [
{
Expand Down Expand Up @@ -49388,6 +49397,7 @@
"x-expandableFields": [
"actions",
"applies_to",
"cancel_subscription_schedule",
"ends_at",
"set_pause_collection",
"starts_at",
Expand Down Expand Up @@ -51302,6 +51312,36 @@
"type": "object",
"x-expandableFields": []
},
"quotes_resource_quote_lines_cancel_subscription_schedule": {
"description": "Configures the immediate cancellation settings for a subscription schedule via quotes.",
"properties": {
"cancel_at": {
"description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.",
"enum": [
"line_starts_at"
],
"type": "string"
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.",
"nullable": true,
"type": "boolean"
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.",
"nullable": true,
"type": "boolean"
}
},
"required": [
"cancel_at",
"invoice_now",
"prorate"
],
"title": "QuotesResourceQuoteLinesCancelSubscriptionSchedule",
"type": "object",
"x-expandableFields": []
},
"quotes_resource_quote_lines_end_behavior": {
"description": "Defines how the scheduled subscription behaves when a trial ends.",
"properties": {
Expand Down Expand Up @@ -160869,6 +160909,31 @@
],
"type": "string"
},
"cancel_subscription_schedule": {
"description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for metadata modifications.",
"properties": {
"cancel_at": {
"description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.",
"enum": [
"line_starts_at"
],
"type": "string"
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.",
"type": "boolean"
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.",
"type": "boolean"
}
},
"required": [
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
"type": "object"
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
"properties": {
Expand Down Expand Up @@ -163046,6 +163111,31 @@
],
"type": "string"
},
"cancel_subscription_schedule": {
"description": "A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for metadata modifications.",
"properties": {
"cancel_at": {
"description": "Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.",
"enum": [
"line_starts_at"
],
"type": "string"
},
"invoice_now": {
"description": "If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.",
"type": "boolean"
},
"prorate": {
"description": "If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.",
"type": "boolean"
}
},
"required": [
"cancel_at"
],
"title": "cancel_subscription_schedule_specs",
"type": "object"
},
"ends_at": {
"description": "Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.",
"properties": {
Expand Down
Loading