From 1fb33dfc0d6545fb4e4b79fac07ebb10d597dd41 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Fri, 29 Mar 2024 16:57:32 +0000 Subject: [PATCH] Update OpenAPI for 2ba2a8ad0df6088c8748d8444d67c591d8f69b60 --- embedded/openapi/fixtures3.json | 77 +- embedded/openapi/spec3.beta.sdk.json | 490 +------ embedded/openapi/spec3.json | 1868 +++++++++++++++++++++----- 3 files changed, 1635 insertions(+), 800 deletions(-) diff --git a/embedded/openapi/fixtures3.json b/embedded/openapi/fixtures3.json index f6e85b4c..7d62cf41 100644 --- a/embedded/openapi/fixtures3.json +++ b/embedded/openapi/fixtures3.json @@ -273,6 +273,56 @@ "routing_number": "110000000", "status": "new" }, + "billing.meter": { + "created": 1234567890, + "customer_mapping": { + "event_payload_key": "customer", + "type": "by_id" + }, + "default_aggregation": { + "formula": "sum" + }, + "display_name": "test-meter", + "event_name": "test-meter-event-name", + "event_time_window": null, + "id": "meter_123", + "livemode": true, + "object": "billing.meter", + "status": "active", + "status_transitions": { + "deactivated_at": null + }, + "updated": 1234567890, + "value_settings": { + "event_payload_key": "value" + } + }, + "billing.meter_event": { + "created": 1234567890, + "event_name": "api_request", + "identifier": "1234-1234", + "livemode": false, + "object": "billing.meter_event", + "payload": { + "stripe_customer_id": "cus_123", + "value": "25" + }, + "timestamp": 1234567890 + }, + "billing.meter_event_adjustment": { + "livemode": false, + "object": "billing.meter_event_adjustment", + "status": "complete" + }, + "billing.meter_event_summary": { + "aggregated_value": 25, + "end_time": 1234567890, + "id": "mtrusg_123", + "livemode": false, + "meter": "mtr_123", + "object": "billing.meter_event_summary", + "start_time": 1234567890 + }, "billing_portal.configuration": { "active": true, "application": null, @@ -1518,6 +1568,17 @@ "metadata": {}, "object": "file_link", "url": "https://ramya-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xT3dxVFFDN2pxbENiRVdBfGZsX3Rlc3Rfd2hFeUJKWHFKYk5adVJ1Nmd1RVZRZVpW00TOfdfMgl" + }, + { + "created": 1711575698, + "expired": false, + "expires_at": null, + "file": "file_1Oz4E2JDlh28ZWA1jiewbKBO", + "id": "link_1Oz4E2JDlh28ZWA1AhZkv28r", + "livemode": false, + "metadata": {}, + "object": "file_link", + "url": "https://crystal-npwcda--upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xT3o0RExKRGxoMjhaV0ExfGZsX3Rlc3RfQmdheWFvYXR3M3JWemZkUzFaZG9YMTR000x2cmFxaR" } ], "has_more": false, @@ -1659,14 +1720,9 @@ "country": "DE", "financial_addresses": [ { - "iban": { - "account_holder_name": "Stripe Technology Europe Limited", - "bic": "SXPYDEHH", - "country": "DE", - "iban": "DE00000000000000000001" - }, "supported_networks": [ - "sepa" + "sepa", + "domestic_wire_us" ], "type": "iban" } @@ -1999,7 +2055,6 @@ "livemode": false, "metadata": {}, "object": "issuing.card", - "personalization_design": null, "replaced_by": null, "replacement_for": null, "replacement_reason": null, @@ -2124,7 +2179,6 @@ "livemode": false, "metadata": {}, "object": "issuing.card", - "personalization_design": null, "replaced_by": null, "replacement_for": null, "replacement_reason": null, @@ -2226,11 +2280,6 @@ "status": "review" }, "issuing.physical_bundle": { - "features": { - "card_logo": "unsupported", - "carrier_text": "unsupported", - "second_line": "unsupported" - }, "id": "ics_PjUv222Xszs9R1", "livemode": false, "name": "My Card Bundle V1", diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index c4667cc5..e62513bf 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -1862,6 +1862,7 @@ "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", + "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", @@ -40313,7 +40314,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -41027,7 +41028,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -41764,6 +41765,7 @@ "bank_name", "fingerprint", "last4", + "payment_reference", "routing_number" ], "title": "payment_method_details_us_bank_account", @@ -46315,9 +46317,6 @@ "subscription_cancel": { "$ref": "#/components/schemas/portal_subscription_cancel" }, - "subscription_pause": { - "$ref": "#/components/schemas/portal_subscription_pause" - }, "subscription_update": { "$ref": "#/components/schemas/portal_subscription_update" } @@ -46327,7 +46326,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ], "title": "PortalFeatures", @@ -46337,7 +46335,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ] }, @@ -46780,21 +46777,6 @@ "type": "object", "x-expandableFields": [] }, - "portal_subscription_pause": { - "description": "", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "required": [ - "enabled" - ], - "title": "PortalSubscriptionPause", - "type": "object", - "x-expandableFields": [] - }, "portal_subscription_update": { "description": "", "properties": { @@ -70227,7 +70209,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2023-10-16; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v1; invoice_payment_plans_beta=v1", + "version": "2024-04-03; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; invoice_partial_payments_beta=v1; invoice_payment_plans_beta=v1", "x-stripeSpecFilename": "spec3.beta.sdk" }, "openapi": "3.0.0", @@ -79814,7 +79796,7 @@ "type": "array" }, "identifier": { - "description": "A unique identifier for the event. If not provided, one will be generated.", + "description": "A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.", "maxLength": 100, "type": "string" }, @@ -80984,17 +80966,6 @@ "title": "subscription_cancel_creation_param", "type": "object" }, - "subscription_pause": { - "description": "Information about pausing subscriptions in the portal.", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { @@ -81465,17 +81436,6 @@ "title": "subscription_cancel_updating_param", "type": "object" }, - "subscription_pause": { - "description": "Information about pausing subscriptions in the portal.", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "description": "Information about updating subscriptions in the portal.", "properties": { @@ -104411,33 +104371,9 @@ "explode": true, "style": "deepObject" }, - "subscription_billing_cycle_anchor": { - "explode": true, - "style": "deepObject" - }, - "subscription_cancel_at": { - "explode": true, - "style": "deepObject" - }, - "subscription_default_tax_rates": { - "explode": true, - "style": "deepObject" - }, "subscription_details": { "explode": true, "style": "deepObject" - }, - "subscription_items": { - "explode": true, - "style": "deepObject" - }, - "subscription_prebilling": { - "explode": true, - "style": "deepObject" - }, - "subscription_trial_end": { - "explode": true, - "style": "deepObject" } }, "schema": { @@ -106757,64 +106693,6 @@ "maxLength": 5000, "type": "string" }, - "subscription_billing_cycle_anchor": { - "anyOf": [ - { - "enum": [ - "now", - "unchanged" - ], - "maxLength": 5000, - "type": "string" - }, - { - "format": "unix-time", - "type": "integer" - } - ], - "description": "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead." - }, - "subscription_cancel_at": { - "anyOf": [ - { - "format": "unix-time", - "type": "integer" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead." - }, - "subscription_cancel_at_period_end": { - "description": "Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.", - "type": "boolean" - }, - "subscription_cancel_now": { - "description": "This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.", - "type": "boolean" - }, - "subscription_default_tax_rates": { - "anyOf": [ - { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead." - }, "subscription_details": { "description": "The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.", "properties": { @@ -107178,305 +107056,6 @@ }, "title": "subscription_details_params", "type": "object" - }, - "subscription_items": { - "description": "A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.", - "items": { - "properties": { - "billing_thresholds": { - "anyOf": [ - { - "properties": { - "usage_gte": { - "description": "Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))", - "type": "integer" - } - }, - "required": [ - "usage_gte" - ], - "title": "item_billing_thresholds_param", - "type": "object" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds." - }, - "clear_usage": { - "description": "Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.", - "type": "boolean" - }, - "deleted": { - "description": "A flag that, if set to `true`, will delete the specified item.", - "type": "boolean" - }, - "discounts": { - "anyOf": [ - { - "items": { - "properties": { - "coupon": { - "description": "ID of the coupon to create a new discount for.", - "maxLength": 5000, - "type": "string" - }, - "discount": { - "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.", - "maxLength": 5000, - "type": "string" - }, - "discount_end": { - "description": "Details to determine how long the discount should be applied for.", - "properties": { - "duration": { - "description": "Time span for the redeemed discount.", - "properties": { - "interval": { - "description": "Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.", - "enum": [ - "day", - "month", - "week", - "year" - ], - "type": "string" - }, - "interval_count": { - "description": "The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.", - "type": "integer" - } - }, - "required": [ - "interval", - "interval_count" - ], - "title": "discount_end_duration_specs", - "type": "object" - }, - "timestamp": { - "description": "A precise Unix timestamp for the discount to end. Must be in the future.", - "format": "unix-time", - "type": "integer" - }, - "type": { - "description": "The type of calculation made to determine when the discount ends.", - "enum": [ - "duration", - "timestamp" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "title": "discount_end", - "type": "object" - }, - "promotion_code": { - "description": "ID of the promotion code to create a new discount for.", - "maxLength": 5000, - "type": "string" - } - }, - "title": "discounts_data_param", - "type": "object" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "The coupons to redeem into discounts for the subscription item." - }, - "id": { - "description": "Subscription item to update.", - "maxLength": 5000, - "type": "string" - }, - "metadata": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "enum": [ - "" - ], - "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." - }, - "plan": { - "description": "Plan ID for this item, as a string.", - "maxLength": 5000, - "type": "string" - }, - "price": { - "description": "The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.", - "maxLength": 5000, - "type": "string" - }, - "price_data": { - "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.", - "properties": { - "currency": { - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", - "type": "string" - }, - "product": { - "description": "The ID of the product that this price will belong to.", - "maxLength": 5000, - "type": "string" - }, - "recurring": { - "description": "The recurring components of a price such as `interval` and `interval_count`.", - "properties": { - "interval": { - "description": "Specifies billing frequency. Either `day`, `week`, `month` or `year`.", - "enum": [ - "day", - "month", - "week", - "year" - ], - "type": "string" - }, - "interval_count": { - "description": "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).", - "type": "integer" - } - }, - "required": [ - "interval" - ], - "title": "recurring_adhoc", - "type": "object" - }, - "tax_behavior": { - "description": "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", - "enum": [ - "exclusive", - "inclusive", - "unspecified" - ], - "type": "string" - }, - "unit_amount": { - "description": "A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.", - "type": "integer" - }, - "unit_amount_decimal": { - "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.", - "format": "decimal", - "type": "string" - } - }, - "required": [ - "currency", - "product", - "recurring" - ], - "title": "recurring_price_data", - "type": "object" - }, - "quantity": { - "description": "Quantity for this item.", - "type": "integer" - }, - "tax_rates": { - "anyOf": [ - { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - { - "enum": [ - "" - ], - "type": "string" - } - ], - "description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates." - } - }, - "title": "subscription_item_update_params", - "type": "object" - }, - "type": "array" - }, - "subscription_prebilling": { - "description": "The pre-billing to apply to the subscription as a preview. This field has been deprecated and will be removed in a future API version. Use `subscription_details.prebilling` instead.", - "properties": { - "iterations": { - "description": "This is used to determine the number of billing cycles to prebill.", - "type": "integer" - } - }, - "required": [ - "iterations" - ], - "title": "prebilling_preview_params", - "type": "object" - }, - "subscription_proration_behavior": { - "description": "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.", - "enum": [ - "always_invoice", - "create_prorations", - "none" - ], - "type": "string" - }, - "subscription_proration_date": { - "description": "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.", - "format": "unix-time", - "type": "integer" - }, - "subscription_resume_at": { - "description": "For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.", - "enum": [ - "now" - ], - "maxLength": 5000, - "type": "string" - }, - "subscription_start_date": { - "description": "Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.", - "format": "unix-time", - "type": "integer" - }, - "subscription_trial_end": { - "anyOf": [ - { - "enum": [ - "now" - ], - "maxLength": 5000, - "type": "string" - }, - { - "format": "unix-time", - "type": "integer" - } - ], - "description": "If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead." } }, "type": "object" @@ -129593,7 +129172,7 @@ "description": "If paying by `afterpay_clearpay`, this sub-hash contains details about the AfterpayClearpay payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "automatic", "automatic_async", @@ -129779,7 +129358,7 @@ "description": "If paying by `klarna`, this sub-hash contains details about the Klarna payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -129853,7 +129432,7 @@ "description": "If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.", "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -131251,7 +130830,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "automatic", "automatic_async", @@ -131497,7 +131076,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -131581,7 +131160,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -134712,7 +134291,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -134749,7 +134328,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -134965,7 +134544,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -135426,7 +135005,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -135684,7 +135263,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -135851,7 +135430,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -135890,7 +135469,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -138776,7 +138355,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -138813,7 +138392,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -139029,7 +138608,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -139490,7 +139069,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -139748,7 +139327,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -139915,7 +139494,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -139954,7 +139533,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -143776,7 +143355,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -143813,7 +143392,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -144029,7 +143608,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -144490,7 +144069,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -144748,7 +144327,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -144915,7 +144494,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -144954,7 +144533,7 @@ { "properties": { "capture_method": { - "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", + "description": "Controls when the funds will be captured from the customer's account.\n\nIf provided, this parameter will override the top level behavior of `capture_method` when finalizing the payment with this payment method type.\n\nIf `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.", "enum": [ "", "manual" @@ -202882,7 +202461,8 @@ "2022-08-01", "2022-11-15", "2023-08-16", - "2023-10-16" + "2023-10-16", + "2024-04-03" ], "maxLength": 5000, "type": "string", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 679495b9..ed0e1acf 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -1398,6 +1398,7 @@ "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", + "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", @@ -2997,6 +2998,242 @@ "type": "object", "x-expandableFields": [] }, + "billing.meter": { + "description": "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then use the billing meter to charge the user for the number of API calls they make.", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "customer_mapping": { + "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings" + }, + "default_aggregation": { + "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings" + }, + "display_name": { + "description": "The meter's name.", + "maxLength": 5000, + "type": "string" + }, + "event_name": { + "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "maxLength": 5000, + "type": "string" + }, + "event_time_window": { + "description": "The time window to pre-aggregate usage events for, if any.", + "enum": [ + "day", + "hour" + ], + "nullable": true, + "type": "string" + }, + "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" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter" + ], + "type": "string" + }, + "status": { + "description": "The meter's status.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "status_transitions": { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions" + }, + "updated": { + "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "value_settings": { + "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value" + } + }, + "required": [ + "created", + "customer_mapping", + "default_aggregation", + "display_name", + "event_name", + "id", + "livemode", + "object", + "status", + "status_transitions", + "updated", + "value_settings" + ], + "title": "BillingMeter", + "type": "object", + "x-expandableFields": [ + "customer_mapping", + "default_aggregation", + "status_transitions", + "value_settings" + ], + "x-resourceId": "billing.meter" + }, + "billing.meter_event": { + "description": "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.", + "properties": { + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "identifier": { + "description": "A unique identifier for the event.", + "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" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event" + ], + "type": "string" + }, + "payload": { + "additionalProperties": { + "maxLength": 100, + "type": "string" + }, + "description": "The payload of the event.", + "type": "object" + }, + "timestamp": { + "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "created", + "event_name", + "identifier", + "livemode", + "object", + "payload", + "timestamp" + ], + "title": "BillingMeterEvent", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "billing.meter_event" + }, + "billing.meter_event_adjustment": { + "description": "A billing meter event adjustment represents the status of a meter event adjustment.", + "properties": { + "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" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event_adjustment" + ], + "type": "string" + }, + "status": { + "description": "The meter event adjustment's status.", + "enum": [ + "complete", + "pending" + ], + "type": "string" + } + }, + "required": [ + "livemode", + "object", + "status" + ], + "title": "BillingMeterEventAdjustment", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "billing.meter_event_adjustment" + }, + "billing.meter_event_summary": { + "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.", + "properties": { + "aggregated_value": { + "description": "Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via `default_aggregation``.", + "type": "number" + }, + "end_time": { + "description": "End timestamp for this usage summary (inclusive).", + "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" + }, + "meter": { + "description": "The meter associated with this usage summary.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "billing.meter_event_summary" + ], + "type": "string" + }, + "start_time": { + "description": "Start timestamp for this usage summary (inclusive).", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "aggregated_value", + "end_time", + "id", + "livemode", + "meter", + "object", + "start_time" + ], + "title": "BillingMeterEventSummary", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "billing.meter_event_summary" + }, "billing_details": { "description": "", "properties": { @@ -3034,6 +3271,79 @@ "address" ] }, + "billing_meter_resource_aggregation_settings": { + "description": "", + "properties": { + "formula": { + "description": "Specifies how events are aggregated.", + "enum": [ + "count", + "sum" + ], + "type": "string" + } + }, + "required": [ + "formula" + ], + "title": "BillingMeterResourceAggregationSettings", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_billing_meter_status_transitions": { + "description": "", + "properties": { + "deactivated_at": { + "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch.", + "format": "unix-time", + "nullable": true, + "type": "integer" + } + }, + "title": "BillingMeterResourceBillingMeterStatusTransitions", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_billing_meter_value": { + "description": "", + "properties": { + "event_payload_key": { + "description": "The key in the usage event payload to use as the value for this meter.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "event_payload_key" + ], + "title": "BillingMeterResourceBillingMeterValue", + "type": "object", + "x-expandableFields": [] + }, + "billing_meter_resource_customer_mapping_settings": { + "description": "", + "properties": { + "event_payload_key": { + "description": "The key in the usage event payload to use for mapping the event to a customer.", + "maxLength": 5000, + "type": "string" + }, + "type": { + "description": "The method for mapping a meter event to a customer.", + "enum": [ + "by_id" + ], + "type": "string" + } + }, + "required": [ + "event_payload_key", + "type" + ], + "title": "BillingMeterResourceCustomerMappingSettings", + "type": "object", + "x-expandableFields": [] + }, "billing_portal.configuration": { "description": "A portal configuration describes the functionality and behavior of a portal session.", "properties": { @@ -28061,7 +28371,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -28686,7 +28996,7 @@ "type": "string" }, "cardholder_verification_method": { - "description": "How the cardholder verified ownership of the card.", + "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.", "maxLength": 5000, "nullable": true, "type": "string" @@ -32676,6 +32986,12 @@ "nullable": true, "type": "object" }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, @@ -32924,9 +33240,6 @@ "subscription_cancel": { "$ref": "#/components/schemas/portal_subscription_cancel" }, - "subscription_pause": { - "$ref": "#/components/schemas/portal_subscription_pause" - }, "subscription_update": { "$ref": "#/components/schemas/portal_subscription_update" } @@ -32936,7 +33249,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ], "title": "PortalFeatures", @@ -32946,7 +33258,6 @@ "invoice_history", "payment_method_update", "subscription_cancel", - "subscription_pause", "subscription_update" ] }, @@ -33369,21 +33680,6 @@ "type": "object", "x-expandableFields": [] }, - "portal_subscription_pause": { - "description": "", - "properties": { - "enabled": { - "description": "Whether the feature is enabled.", - "type": "boolean" - } - }, - "required": [ - "enabled" - ], - "title": "PortalSubscriptionPause", - "type": "object", - "x-expandableFields": [] - }, "portal_subscription_update": { "description": "", "properties": { @@ -35207,6 +35503,12 @@ "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.", "type": "integer" }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "usage_type": { "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.", "enum": [ @@ -47932,7 +48234,7 @@ "description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.", "termsOfService": "https://stripe.com/us/terms/", "title": "Stripe API", - "version": "2023-10-16", + "version": "2024-04-03", "x-stripeSpecFilename": "spec3" }, "openapi": "3.0.0", @@ -57901,27 +58203,1191 @@ } } }, - "/v1/balance/history/{id}": { - "get": { - "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", - "operationId": "GetBalanceHistoryId", + "/v1/balance/history/{id}": { + "get": { + "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", + "operationId": "GetBalanceHistoryId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/balance_transaction" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/balance_transactions": { + "get": { + "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", + "operationId": "GetBalanceTransactions", + "parameters": [ + { + "description": "Only return transactions that were created during the given date interval.", + "explode": true, + "in": "query", + "name": "created", + "required": false, + "schema": { + "anyOf": [ + { + "properties": { + "gt": { + "type": "integer" + }, + "gte": { + "type": "integer" + }, + "lt": { + "type": "integer" + }, + "lte": { + "type": "integer" + } + }, + "title": "range_query_specs", + "type": "object" + }, + { + "type": "integer" + } + ] + }, + "style": "deepObject" + }, + { + "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", + "in": "query", + "name": "currency", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", + "in": "query", + "name": "payout", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Only returns the original transaction.", + "in": "query", + "name": "source", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", + "in": "query", + "name": "type", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/balance_transaction" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/balance_transactions", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BalanceTransactionsList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/balance_transactions/{id}": { + "get": { + "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", + "operationId": "GetBalanceTransactionsId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/balance_transaction" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meter_event_adjustments": { + "post": { + "description": "

Creates a billing meter event adjustment

", + "operationId": "PostBillingMeterEventAdjustments", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "cancel": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "cancel": { + "description": "Specifies which event to cancel.", + "properties": { + "identifier": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "identifier" + ], + "title": "event_adjustment_cancel_settings_param", + "type": "object" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Specifies whether to cancel a single event or a range of events for a time period.", + "enum": [ + "cancel" + ], + "type": "string" + } + }, + "required": [ + "cancel" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter_event_adjustment" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meter_events": { + "post": { + "description": "

Creates a billing meter event

", + "operationId": "PostBillingMeterEvents", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + }, + "payload": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "event_name": { + "description": "The name of the meter event. Corresponds with the `event_name` field on a meter.", + "maxLength": 100, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "identifier": { + "description": "A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.", + "maxLength": 100, + "type": "string" + }, + "payload": { + "additionalProperties": { + "type": "string" + }, + "description": "The payload of the event. This must contain a field with the event's numerical value and a field to map the event to a customer.", + "type": "object" + }, + "timestamp": { + "description": "The time of the event. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + } + }, + "required": [ + "event_name", + "payload", + "timestamp" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter_event" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters": { + "get": { + "description": "

Retrieve a list of billing meters.

", + "operationId": "GetBillingMeters", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter results to only include meters with the given status.", + "in": "query", + "name": "status", + "required": false, + "schema": { + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.meter" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/billing/meters", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BillingMeterResourceBillingMeterList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Creates a billing meter

", + "operationId": "PostBillingMeters", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "customer_mapping": { + "explode": true, + "style": "deepObject" + }, + "default_aggregation": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "value_settings": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "customer_mapping": { + "description": "Fields that specify how to map a meter event to a customer.", + "properties": { + "event_payload_key": { + "maxLength": 100, + "type": "string" + }, + "type": { + "enum": [ + "by_id" + ], + "type": "string" + } + }, + "required": [ + "event_payload_key", + "type" + ], + "title": "customer_mapping_param", + "type": "object" + }, + "default_aggregation": { + "description": "The default settings to aggregate a meter's events with.", + "properties": { + "formula": { + "enum": [ + "count", + "sum" + ], + "type": "string" + } + }, + "required": [ + "formula" + ], + "title": "aggregation_settings_param", + "type": "object" + }, + "display_name": { + "description": "The meter's name.", + "maxLength": 250, + "type": "string" + }, + "event_name": { + "description": "The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.", + "maxLength": 100, + "type": "string" + }, + "event_time_window": { + "description": "The time window to pre-aggregate usage events for, if any.", + "enum": [ + "day", + "hour" + ], + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "value_settings": { + "description": "Fields that specify how to calculate a usage event's value.", + "properties": { + "event_payload_key": { + "maxLength": 100, + "type": "string" + } + }, + "required": [ + "event_payload_key" + ], + "title": "meter_value_settings_param", + "type": "object" + } + }, + "required": [ + "default_aggregation", + "display_name", + "event_name" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters/{id}": { + "get": { + "description": "

Retrieves a billing meter given an ID

", + "operationId": "GetBillingMetersId", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Updates a billing meter

", + "operationId": "PostBillingMetersId", + "parameters": [ + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "display_name": { + "description": "The meter's name.", + "maxLength": 250, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters/{id}/deactivate": { + "post": { + "description": "

Deactivates a billing meter

", + "operationId": "PostBillingMetersIdDeactivate", + "parameters": [ + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing.meter" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters/{id}/event_summaries": { + "get": { + "description": "

Retrieve a list of billing meter event summaries.

", + "operationId": "GetBillingMetersIdEventSummaries", + "parameters": [ + { + "description": "The customer for which to fetch event summaries.", + "in": "query", + "name": "customer", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "The timestamp from when to stop aggregating usage events (exclusive).", + "in": "query", + "name": "end_time", + "required": true, + "schema": { + "format": "unix-time", + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "Unique identifier for the object.", + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The timestamp from when to start aggregating usage events (inclusive).", + "in": "query", + "name": "start_time", + "required": true, + "schema": { + "format": "unix-time", + "type": "integer" + }, + "style": "form" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range.", + "in": "query", + "name": "value_grouping_window", + "required": false, + "schema": { + "enum": [ + "hour" + ], + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/billing.meter_event_summary" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/billing/meters/[^/]+/event_summaries", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "BillingMeterResourceBillingMeterEventSummaryList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/billing/meters/{id}/reactivate": { + "post": { + "description": "

Reactivates a billing meter

", + "operationId": "PostBillingMetersIdReactivate", "parameters": [ { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { + "description": "Unique identifier for the object.", "in": "path", "name": "id", "required": true, @@ -57935,280 +59401,24 @@ "requestBody": { "content": { "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/balance_transaction" - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/balance_transactions": { - "get": { - "description": "

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

\n\n

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

", - "operationId": "GetBalanceTransactions", - "parameters": [ - { - "description": "Only return transactions that were created during the given date interval.", - "explode": true, - "in": "query", - "name": "created", - "required": false, - "schema": { - "anyOf": [ - { - "properties": { - "gt": { - "type": "integer" - }, - "gte": { - "type": "integer" - }, - "lt": { - "type": "integer" - }, - "lte": { - "type": "integer" - } - }, - "title": "range_query_specs", - "type": "object" - }, - { - "type": "integer" + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" } - ] - }, - "style": "deepObject" - }, - { - "description": "Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).", - "in": "query", - "name": "currency", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", - "in": "query", - "name": "ending_before", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" }, - "type": "array" - }, - "style": "deepObject" - }, - { - "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "integer" - }, - "style": "form" - }, - { - "description": "For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.", - "in": "query", - "name": "payout", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Only returns the original transaction.", - "in": "query", - "name": "source", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", - "in": "query", - "name": "starting_after", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - }, - { - "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.", - "in": "query", - "name": "type", - "required": false, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, "schema": { "additionalProperties": false, - "properties": {}, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/balance_transaction" - }, - "type": "array" - }, - "has_more": { - "description": "True if this list has another page of items after this one that can be fetched.", - "type": "boolean" - }, - "object": { - "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", - "enum": [ - "list" - ], - "type": "string" - }, - "url": { - "description": "The URL where this list can be accessed.", + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { "maxLength": 5000, - "pattern": "^/v1/balance_transactions", "type": "string" - } - }, - "required": [ - "data", - "has_more", - "object", - "url" - ], - "title": "BalanceTransactionsList", - "type": "object", - "x-expandableFields": [ - "data" - ] - } - } - }, - "description": "Successful response." - }, - "default": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error" - } - } - }, - "description": "Error response." - } - } - } - }, - "/v1/balance_transactions/{id}": { - "get": { - "description": "

Retrieves the balance transaction with the given ID.

\n\n

Note that this endpoint previously used the path /v1/balance/history/:id.

", - "operationId": "GetBalanceTransactionsId", - "parameters": [ - { - "description": "Specifies which fields in the response should be expanded.", - "explode": true, - "in": "query", - "name": "expand", - "required": false, - "schema": { - "items": { - "maxLength": 5000, - "type": "string" - }, - "type": "array" - }, - "style": "deepObject" - }, - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "maxLength": 5000, - "type": "string" - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "encoding": {}, - "schema": { - "additionalProperties": false, - "properties": {}, + }, + "type": "array" + } + }, "type": "object" } } @@ -58220,7 +59430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/balance_transaction" + "$ref": "#/components/schemas/billing.meter" } } }, @@ -58597,15 +59807,6 @@ "title": "subscription_cancel_creation_param", "type": "object" }, - "subscription_pause": { - "properties": { - "enabled": { - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "properties": { "default_allowed_updates": { @@ -59051,15 +60252,6 @@ "title": "subscription_cancel_updating_param", "type": "object" }, - "subscription_pause": { - "properties": { - "enabled": { - "type": "boolean" - } - }, - "title": "subscription_pause_param", - "type": "object" - }, "subscription_update": { "properties": { "default_allowed_updates": { @@ -60892,7 +62084,7 @@ "additionalProperties": false, "properties": { "amount": { - "description": "A positive integer in cents (or local equivalent) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.", + "description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.", "type": "integer" }, "expand": { @@ -112093,6 +113285,11 @@ ], "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`." }, + "meter": { + "description": "The meter tracking the usage of a metered price", + "maxLength": 5000, + "type": "string" + }, "nickname": { "description": "A brief description of the plan, hidden from customers.", "maxLength": 5000, @@ -112623,6 +113820,10 @@ ], "type": "string" }, + "meter": { + "maxLength": 5000, + "type": "string" + }, "usage_type": { "enum": [ "licensed", @@ -112995,6 +114196,10 @@ "interval_count": { "type": "integer" }, + "meter": { + "maxLength": 5000, + "type": "string" + }, "usage_type": { "enum": [ "licensed", @@ -150507,7 +151712,8 @@ "2022-08-01", "2022-11-15", "2023-08-16", - "2023-10-16" + "2023-10-16", + "2024-04-03" ], "maxLength": 5000, "type": "string",