{"RmqXlPHYXl6U-L9Qo1o59Ql0zcgZPzJRNygulLkK":{"page":{"title":"OpenPay API","description":"","type":"openapi-single","mode":"folder","config":{"expandAllResponses":false,"expandAllModelSections":false,"defaultOpenAllTags":false,"showOperationId":false,"hideTestRequestButton":false,"documentDownloadType":"both","hideModels":false,"orderSchemaPropertiesBy":"alpha","orderRequiredPropertiesFirst":true,"operationTitleSource":"summary","hideClientButton":false},"singlePage":true,"showInSidebar":true,"slug":"openpay-api","namespace":"openpay","version":"default","isIndex":false,"uid":"RmqXlPHYXl6U-L9Qo1o59Ql0zcgZPzJRNygulLkK","breadcrumbs":[{"type":"root-group","path":"/openpay-api","uid":"RmqXlPHYXl6U-L9Qo1o59Ql0zcgZPzJRNygulLkK","title":"OpenPay API"}],"apiVersion":"latest"},"content":{"components":{"schemas":{"ActiveSubResponse":{"properties":{"has_active_subscriptions":{"title":"Has Active Subscriptions","type":"boolean"},"subscriptions":{"items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Subscriptions","type":"array"}},"required":["has_active_subscriptions","subscriptions"],"title":"ActiveSubResponse","type":"object"},"AddCommentRequest":{"properties":{"comment":{"description":"Remarks on the invoice.","example":"Marked as paid.","title":"Comment","type":"string"}},"required":["comment"],"title":"AddCommentRequest","type":"object"},"AttachPaymentMethodRequest":{"properties":{"customer_id":{"description":"Unique Identifier of the payment_method.","example":"cus_dev_abc123","title":"Customer Id","type":"string"}},"required":["customer_id"],"title":"AttachPaymentMethodRequest","type":"object"},"AuthorizePaymentMethodRequest":{"properties":{"authorize_amount_atom":{"default":2000,"description":"Amount to authorize in atoms (smallest currency unit).","example":2000,"title":"Authorize Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd","description":"Currency for the authorization amount.","example":"usd"},"payment_method_id":{"description":"Unique identifier of the payment method.","example":"pm_dev_abc123","title":"Payment Method Id","type":"string"}},"required":["payment_method_id"],"title":"AuthorizePaymentMethodRequest","type":"object"},"BillingMeterAdjustmentType":{"enum":["cancel"],"title":"BillingMeterAdjustmentType","type":"string"},"BillingMeterAggregationFormula":{"enum":["sum","count"],"title":"BillingMeterAggregationFormula","type":"string"},"BillingMeterEventAdjustmentExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","examples":["account_dev_abc123"],"title":"Account Id","type":"string"},"cancel_identifier":{"description":"Unique identifier for the event.","title":"Cancel Identifier","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"event_name":{"description":"The name of the meter event. Corresponds with the event_name field on a meter.","title":"Event Name","type":"string"},"id":{"description":"Unique identifier of meter event.","examples":["mtr_event_adj_dev_abc123"],"title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"billing_meter_event_adjustment"},"status":{"$ref":"#/components/schemas/BillingMeterEventAdjustmentStatus","description":"Status of the billing meter adjustment event."},"type":{"$ref":"#/components/schemas/BillingMeterAdjustmentType","default":"cancel","description":"Specifies whether to cancel a single event."},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["cancel_identifier","event_name","id","created_at","updated_at","account_id","status"],"title":"BillingMeterEventAdjustmentExternal","type":"object"},"BillingMeterEventAdjustmentStatus":{"enum":["pending","complete"],"title":"BillingMeterEventAdjustmentStatus","type":"string"},"BillingMeterEventExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","examples":["account_dev_abc123"],"title":"Account Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"event_datetime":{"description":"The time of the event.","examples":["2023-10-02T08:49:54.678156Z"],"format":"date-time","title":"Event Datetime","type":"string"},"event_name":{"description":"The name of the meter event. Corresponds with the event_name field on a meter.","examples":["metered_event_x"],"title":"Event Name","type":"string"},"id":{"description":"Unique identifier of meter event.","examples":["mtr_event_dev_abc123"],"title":"Id","type":"string"},"identifier":{"description":"A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this.","examples":["8091436b-2eb8-49ef-8a11-bd23b6cf81ef"],"title":"Identifier","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"billing_meter_event"},"payload":{"description":"The payload of the event. This must contain the fields corresponding to a meter’s event_payload_customer_mapping_key (default is customer_id) and event_payload_value_key (default is value). ","examples":[{"customer_id":"cus_dev_abc123","value":12}],"title":"Payload","type":"object"},"status":{"$ref":"#/components/schemas/BillingMeterEventStatus","description":"Status of the billing meter event."},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["event_name","payload","id","created_at","updated_at","account_id","status"],"title":"BillingMeterEventExternal","type":"object"},"BillingMeterEventStatus":{"enum":["active","canceled","billed"],"title":"BillingMeterEventStatus","type":"string"},"BillingMeterExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"aggregation_formula":{"$ref":"#/components/schemas/BillingMeterAggregationFormula","default":"sum","description":"Specifies how events are aggregated. Allowed values are count to count the number of events and sum to sum each event’s value."},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"display_name":{"description":"The meter’s name.","examples":["meter_x"],"title":"Display Name","type":"string"},"event_name":{"description":"The name of the meter event to record usage for. Corresponds with the event_name field on meter events.","examples":["metered_event_x"],"pattern":"^[A-Za-z0-9_-]+$","title":"Event Name","type":"string"},"event_payload_customer_mapping_key":{"default":"customer_id","description":"The key in the usage event payload to use for mapping the event to a customer.","examples":["customer_id"],"title":"Event Payload Customer Mapping Key","type":"string"},"event_payload_value_key":{"default":"value","description":"The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a bytes_used field, then set the event_payload_value_key to “bytes_used”.","examples":["bytes_used"],"title":"Event Payload Value Key","type":"string"},"id":{"description":"Unique Identifier of the Billing Meter.","example":"mtr_dev_abc123","title":"Id","type":"string"},"is_active":{"description":"The meter’s status.","title":"Is Active","type":"boolean"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"billing_meter"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["display_name","event_name","id","created_at","updated_at","account_id","is_active"],"title":"BillingMeterExternal","type":"object"},"BillingMeterQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter results to only include meters with the given status.","title":"Is Active"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"required":["is_active"],"title":"BillingMeterQueryParams","type":"object"},"BillingMeterSummary":{"properties":{"aggregated_value":{"description":"Aggregated value of all the events within start_time and end_time. The aggregation strategy is defined on meter via default_aggregation.","title":"Aggregated Value","type":"integer"},"document_count":{"description":"Count of events found within start_time and end_time.","title":"Document Count","type":"integer"},"end_datetime":{"description":"End datetime for this event summary","format":"date-time","title":"End Datetime","type":"string"},"meter_id":{"description":"The if of billing meter associated with this event summary.","title":"Meter Id","type":"string"},"start_datetime":{"description":"Start datetime for this event summary","format":"date-time","title":"Start Datetime","type":"string"}},"required":["start_datetime","end_datetime","aggregated_value","document_count","meter_id"],"title":"BillingMeterSummary","type":"object"},"BillingReasonEnum":{"enum":["manual","subscription_create","subscription_cycle","subscription_threshold","subscription_update","upcoming"],"title":"BillingReasonEnum","type":"string"},"BillingSchemeEnum":{"enum":["per_unit","tiered"],"title":"BillingSchemeEnum","type":"string"},"BooleanConfigField":{"properties":{"default_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The default value of the boolean.","title":"Default Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The description of the field.","title":"Description"},"key":{"description":"The key of the field in the config.","title":"Key","type":"string"},"name":{"description":"The name of the field.","title":"Name","type":"string"},"type":{"const":"boolean","default":"boolean","title":"Type","type":"string"},"value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"The value of the field.","title":"Value"}},"required":["name","key","value"],"title":"BooleanConfigField","type":"object"},"CalendarIntervalEnum":{"enum":["day","week","month","year"],"title":"CalendarIntervalEnum","type":"string"},"ChargeExternal":{"properties":{"amount_atom":{"description":"Charge amount without any fees, in smallest currency unit.","example":1200,"title":"Amount Atom","type":"integer"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Currency code, e.g., USD.","example":"usd"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the charge. This can be useful to store the additional data related to the charge.","title":"Custom Fields"},"customer_id":{"description":"ID of the customer associated with this charge.","example":"cust_dev_abc123","title":"Customer Id","type":"string"},"disputed":{"description":"Indicates whether the charge is disputed.","example":false,"title":"Disputed","type":"boolean"},"failure_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Failure code if the charge failed.","title":"Failure Code"},"failure_message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Failure message if the charge failed.","title":"Failure Message"},"id":{"description":"Unique Identifier of the charge.","example":"charge_dev_abc123","title":"Id","type":"string"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the invoice associated with this charge, if applicable.","example":"inv_dev_abc123","title":"Invoice Id"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"charge"},"payment_intent_id":{"description":"ID of the payment intent associated with this charge.","example":"pi_dev_abc123","title":"Payment Intent Id","type":"string"},"payment_intent_mapping_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID for this payment assigned by the payment processor side","example":"extpi_dev_abc123","title":"Payment Intent Mapping Id"},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethodExternal"},{"type":"null"}],"description":"Expandable Payment method used with this charge."},"payment_method_id":{"description":"ID of the payment method used for this charge.","example":"pm_dev_abc123","title":"Payment Method Id","type":"string"},"payment_processor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the payment processor used for this charge.","example":1,"title":"Payment Processor Id"},"payment_processor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the payment processor used for this charge.","title":"Payment Processor Name"},"processor_metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Processor-specific metadata derived from processor's payment attempt.","title":"Processor Metadata"},"provider_type_fee_amount_atom":{"description":"Fee amount charged due to the payment provider type, in smallest currency unit.","example":100,"title":"Provider Type Fee Amount Atom","type":"integer"},"refunded":{"description":"Indicates whether the charge has been refunded.","example":false,"title":"Refunded","type":"boolean"},"refunded_amount_atom":{"description":"Amount refunded, in smallest currency unit.","example":0,"title":"Refunded Amount Atom","type":"integer"},"status":{"$ref":"#/components/schemas/ChargeStatusEnum","description":"Status of the charge.","example":"pending"},"subscription_ids":{"description":"List of subscription ids for which the charge is created.","items":{"type":"string"},"title":"Subscription Ids","type":"array"},"subscriptions":{"description":"List of subscriptions for which the charge is created.","items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Subscriptions","type":"array"},"total_charge_amount_atom":{"description":"Total charge amount including fees, in smallest currency unit.","example":1300,"title":"Total Charge Amount Atom","type":"integer"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_atom","total_charge_amount_atom","provider_type_fee_amount_atom","currency","customer_id","payment_method_id","payment_intent_mapping_id","payment_intent_id","invoice_id","status","refunded","refunded_amount_atom","disputed","failure_code","failure_message","payment_processor_id","payment_processor_name"],"title":"ChargeExternal","type":"object"},"ChargeQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter charges by customer ID.","title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter charges by invoice ID.","title":"Invoice Id"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter charges by payment intent ID.","title":"Payment Intent Id"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter charges by payment method ID.","title":"Payment Method Id"},"refunded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter charges by refunded status.","title":"Refunded"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"status":{"anyOf":[{"$ref":"#/components/schemas/ChargeStatusEnum"},{"type":"null"}],"description":"Filter charges by status."},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"ChargeQueryParams","type":"object"},"ChargeStatusEnum":{"enum":["succeeded","failed","pending"],"title":"ChargeStatusEnum","type":"string"},"CheckoutMode":{"enum":["payment","setup","subscription"],"title":"CheckoutMode","type":"string"},"CheckoutPreferences":{"description":"Preferences for the checkout session.\nAll changes to this object must be backwards-compatible, old objects should still be valid with all new schemas.\n\nNote: this object is stored in both PaymentLinks (in string form) and CheckoutSessions","properties":{"fallback_cascade_preferences":{"default":[],"description":"This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created. Processor preferences here will override the processor preferences in the processor_preferences field.","example":[{"fallback_processor_preferences":{"filter_providers":[],"ids_whitelist":["pp_dev_abc123","pp_dev_def456"],"names_whitelist":["stripe","authorize_net"]},"price_groups":[{"price_id":"test_price_id","quantity":1}]}],"items":{"$ref":"#/components/schemas/FallbackConfiguration-Input"},"title":"Fallback Cascade Preferences","type":"array"},"fallback_cascade_selected_product_price_quantity":{"default":[],"description":"This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created.","example":[[{"price_id":"test_price_id","quantity":1}]],"items":{"items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"type":"array"},"title":"Fallback Cascade Selected Product Price Quantity","type":"array"},"processor_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutProcessorsPreferences"},{"type":"null"}],"description":"Processor preferences for the checkout session. Note that this can be overriden by ","examples":[{"filter_providers":[],"ids_whitelist":["pp_dev_abc123","pp_dev_def456"],"names_whitelist":["stripe","authorize_net"]}]}},"title":"CheckoutPreferences","type":"object"},"CheckoutPreferencesOutput":{"properties":{"fallback_cascade_preferences":{"default":[],"description":"This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created. Processor preferences here will override the processor preferences in the processor_preferences field.","example":[{"fallback_processor_preferences":{"filter_providers":[],"ids_whitelist":["pp_dev_abc123","pp_dev_def456"],"names_whitelist":["stripe","authorize_net"]},"price_groups":[{"price_id":"test_price_id","quantity":1}]}],"items":{"$ref":"#/components/schemas/FallbackConfiguration-Output"},"title":"Fallback Cascade Preferences","type":"array"},"fallback_cascade_selected_product_price_quantity":{"default":[],"description":"This object contains a list of price groups that will be used to fall back to if the selected product price quantity fails to be created.","example":[[{"price_id":"test_price_id","quantity":1}]],"items":{"items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"type":"array"},"title":"Fallback Cascade Selected Product Price Quantity","type":"array"},"processor_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutProcessorsPreferences"},{"type":"null"}],"description":"Processor preferences for the checkout session. Note that this can be overriden by ","examples":[{"filter_providers":[],"ids_whitelist":["pp_dev_abc123","pp_dev_def456"],"names_whitelist":["stripe","authorize_net"]}]},"unused":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unused field","title":"Unused"}},"title":"CheckoutPreferencesOutput","type":"object"},"CheckoutProcessorsPreferences":{"description":"Allows customization of which payment processors are available during each checkout session.","properties":{"filter_providers":{"default":[],"description":"If not empty, the enabled providers will be filtered by this list.","example":["credit_card","google_pay"],"items":{"$ref":"#/components/schemas/PaymentProviderType"},"title":"Filter Providers","type":"array"},"ids_whitelist":{"default":[],"description":"If not empty, only the processors with these ids will be accepted.","example":["pp_dev_abc123","pp_dev_def456"],"items":{"type":"string"},"title":"Ids Whitelist","type":"array"},"names_whitelist":{"default":[],"description":"If not empty, only the processors with these names will be accepted. Valid values are: adyen, airwallex, authorize_net, checkout_com, braintree, stripe, foobar, pockyt, cybersource, loop.","example":["stripe","authorize_net"],"items":{"type":"string"},"title":"Names Whitelist","type":"array"}},"title":"CheckoutProcessorsPreferences","type":"object"},"CheckoutSessionExternal":{"properties":{"account_id":{"description":"Unique Identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"account_name":{"description":"Name of the account.","example":"foobar","title":"Account Name","type":"string"},"amount_subtotal_atom":{"description":"The integer amount representing the subtotal amount for the line items.","example":1000,"title":"Amount Subtotal Atom","type":"integer"},"amount_total_atom":{"description":"The integer amount representing the total amount for the line items, after discounts and taxes.","example":900,"title":"Amount Total Atom","type":"integer"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The client reference ID initially referenced during checkout session creation.","example":"your_ref_abc123","title":"Client Reference Id"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this checkout session.","example":"coupon_dev_abc123","title":"Coupon Id"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency code, e.g., USD.","example":"usd","title":"Currency"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs attached to the checkout session.","title":"Custom Fields"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's email.","example":"foobar@gmail.com","title":"Customer Email"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"id":{"description":"Unique Identifier of the checkout session.","example":"cs_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"line_items":{"description":"The line items purchased by the customers.","example":[{"amount_subtotal_atom":1000,"amount_total_atom":1100,"currency":"usd","id":"csli_dev_abc123","price_id":"price_dev_abc123","quantity":3}],"items":{"$ref":"#/components/schemas/CheckoutSessionLineItemExternal"},"title":"Line Items","type":"array"},"mode":{"$ref":"#/components/schemas/CheckoutMode","description":"The mode of the Checkout Session.","example":"payment"},"object":{"$ref":"#/components/schemas/ObjectName","default":"checkout_session"},"return_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.","example":"http://example.com","title":"Return Url"},"secure_token":{"description":"The random secure token associated with the checkout session.","example":"33544253-7d23-4e58-9d58-860977eb36d3","title":"Secure Token","type":"string"},"setup_intent":{"anyOf":[{"$ref":"#/components/schemas/SetupIntentExternal"},{"type":"null"}],"description":"The setup intent used in this checkout session."},"status":{"$ref":"#/components/schemas/CheckoutSessionStatus","description":"The current status of the checkout session.","example":"open"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"deprecated":true,"description":"This field is deprecated and will be removed in future versions. Please use subscription_ids instead.","title":"Subscription Id"},"subscription_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"The list of subscription ids associated with the checkout session.","example":"['subscription_dev_abc123', 'subscription_dev_def456']","title":"Subscription Ids"},"success_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL to which OpenPay should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded.","example":"http://example.com","title":"Success Url"},"tax_amount_atom":{"description":"The integer amount representing the tax amount for the line items.","example":10,"title":"Tax Amount Atom","type":"integer"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime representing the end of the trial period the customer will get before being charged for the first time.","title":"Trial End"},"trial_from_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates if a price's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. In case of subscription containing multiple prices and the trial period of them are not same, minimum of trial days will be used.","example":false,"title":"Trial From Price"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a price","example":30,"title":"Trial Period Days"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"},"url":{"description":"The main URL for this checkout session.","example":"https://pay.getopenpay.com/aaaa-bbbb-cccc-dddd","title":"Url","type":"string"}},"required":["id","created_at","updated_at","account_id","account_name","amount_subtotal_atom","amount_total_atom","currency","customer_id","customer_email","line_items","mode","return_url","secure_token","setup_intent","status","subscription_ids","success_url","tax_amount_atom","url","trial_end","trial_period_days","trial_from_price"],"title":"CheckoutSessionExternal","type":"object"},"CheckoutSessionLineItemExternal":{"properties":{"amount_subtotal_atom":{"title":"Amount Subtotal Atom","type":"integer"},"amount_total_atom":{"title":"Amount Total Atom","type":"integer"},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/CalendarIntervalEnum"},{"type":"null"}]},"billing_interval_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Billing Interval Count"},"checkout_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout Session Id"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"description_detailed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Detailed"},"id":{"title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"checkout_session_item"},"price_id":{"title":"Price Id","type":"string"},"product_id":{"title":"Product Id","type":"string"},"quantity":{"title":"Quantity","type":"integer"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_subtotal_atom","amount_total_atom","checkout_session_id","description","description_detailed","currency","price_id","product_id","billing_interval","billing_interval_count","quantity","custom_fields"],"title":"CheckoutSessionLineItemExternal","type":"object"},"CheckoutSessionQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"payment_link_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter charges by payment link ID.","title":"Payment Link Id"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"CheckoutSessionQueryParams","type":"object"},"CheckoutSessionStatus":{"enum":["open","expired","complete"],"title":"CheckoutSessionStatus","type":"string"},"CheckoutSuccessResponse":{"properties":{"customer_id":{"title":"Customer Id","type":"string"},"invoice_urls":{"items":{"type":"string"},"title":"Invoice Urls","type":"array"},"subscription_ids":{"items":{"type":"string"},"title":"Subscription Ids","type":"array"}},"required":["invoice_urls","subscription_ids","customer_id"],"title":"CheckoutSuccessResponse","type":"object"},"CollectionMethodEnum":{"enum":["charge_automatically","send_invoice"],"title":"CollectionMethodEnum","type":"string"},"CompleteAddress":{"properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line3"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip Code"}},"title":"CompleteAddress","type":"object"},"CouponDuration":{"enum":["once","repeating","forever"],"title":"CouponDuration","type":"string"},"CouponExternal":{"properties":{"amount_atom_off":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Atom Off"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}]},"duration":{"$ref":"#/components/schemas/CouponDuration"},"duration_in_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration In Months"},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"max_redemptions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Redemptions"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"name":{"title":"Name","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"coupon"},"percent_off":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Percent Off"},"product_families":{"default":[],"items":{"type":"string"},"title":"Product Families","type":"array"},"products":{"default":[],"items":{"type":"string"},"title":"Products","type":"array"},"promotion_codes":{"default":[],"items":{"type":"string"},"title":"Promotion Codes","type":"array"},"redeem_by":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Redeem By"},"times_redeemed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Times Redeemed"},"trial_days_off":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Trial Days Off"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","name","is_active","amount_atom_off","percent_off","duration","duration_in_months","max_redemptions","times_redeemed","redeem_by"],"title":"CouponExternal","type":"object"},"CouponQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Filter by the currency of the coupon"},"duration":{"anyOf":[{"$ref":"#/components/schemas/CouponDuration"},{"type":"null"}],"description":"Filter by the duration of the coupon"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether coupon is active or not.","title":"Is Active"},"max_redemptions":{"anyOf":[{"$ref":"#/components/schemas/IntRangeFilter"},{"type":"null"}],"description":"Filter by the max redemptions of the coupon"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"redeem_by":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter by the date the coupon can be redeemed by"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Search for coupons based on provided name, percent_off, amount_atom_off"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"CouponQueryParams","type":"object"},"CreateBillingMeterEventAdjustmentRequest":{"properties":{"cancel_identifier":{"description":"Unique identifier for the event.","title":"Cancel Identifier","type":"string"},"event_name":{"description":"The name of the meter event. Corresponds with the event_name field on a meter.","title":"Event Name","type":"string"},"type":{"$ref":"#/components/schemas/BillingMeterAdjustmentType","default":"cancel","description":"Specifies whether to cancel a single event."}},"required":["cancel_identifier","event_name"],"title":"CreateBillingMeterEventAdjustmentRequest","type":"object"},"CreateBillingMeterEventRequest":{"properties":{"event_datetime":{"description":"The time of the event.","examples":["2023-10-02T08:49:54.678156Z"],"format":"date-time","title":"Event Datetime","type":"string"},"event_name":{"description":"The name of the meter event. Corresponds with the event_name field on a meter.","examples":["metered_event_x"],"title":"Event Name","type":"string"},"identifier":{"description":"A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this.","examples":["8091436b-2eb8-49ef-8a11-bd23b6cf81ef"],"title":"Identifier","type":"string"},"payload":{"description":"The payload of the event. This must contain the fields corresponding to a meter’s event_payload_customer_mapping_key (default is customer_id) and event_payload_value_key (default is value). ","examples":[{"customer_id":"cus_dev_abc123","value":12}],"title":"Payload","type":"object"}},"required":["event_name","payload"],"title":"CreateBillingMeterEventRequest","type":"object"},"CreateBillingMeterRequest":{"properties":{"aggregation_formula":{"$ref":"#/components/schemas/BillingMeterAggregationFormula","default":"sum","description":"Specifies how events are aggregated. Allowed values are count to count the number of events and sum to sum each event’s value."},"display_name":{"description":"The meter’s name.","examples":["meter_x"],"title":"Display Name","type":"string"},"event_name":{"description":"The name of the meter event to record usage for. Corresponds with the event_name field on meter events.","examples":["metered_event_x"],"pattern":"^[A-Za-z0-9_-]+$","title":"Event Name","type":"string"},"event_payload_customer_mapping_key":{"default":"customer_id","description":"The key in the usage event payload to use for mapping the event to a customer.","examples":["customer_id"],"title":"Event Payload Customer Mapping Key","type":"string"},"event_payload_value_key":{"default":"value","description":"The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a bytes_used field, then set the event_payload_value_key to “bytes_used”.","examples":["bytes_used"],"title":"Event Payload Value Key","type":"string"}},"required":["display_name","event_name"],"title":"CreateBillingMeterRequest","type":"object"},"CreateCheckoutLineItem":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Optional set of custom key-value pairs to attach to a subscription item created by a successful checkout.","title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional description field. This description will be inherited by the subscription item which is created by a successful checkout. It appears in invoices and in the hosted checkout page","example":"Example of a checkout line item description!","title":"Description"},"price_id":{"description":"Unique ID of the price corresponding to this line item","example":"price_dev_abc123","title":"Price Id","type":"string"},"quantity":{"description":"The quantity of the line item being purchased.","example":"3","title":"Quantity","type":"integer"}},"required":["price_id","quantity"],"title":"CreateCheckoutLineItem","type":"object"},"CreateCheckoutSessionRequest":{"properties":{"checkout_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutPreferences"},{"type":"null"}],"description":"Checkout preferences for the checkout session.","nullable":true},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.","example":"your_ref_abc123","title":"Client Reference Id"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this checkout session.","example":"coupon_dev_abc123","title":"Coupon Id"},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Three-letter ISO currency code, in lowercase. Only applicable in setup mode.","example":"usd"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach to the checkout session.","title":"Custom Fields"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the customer field.","example":"johndoe@xyz.com","title":"Customer Email"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of an existing Customer, if one exists. The customer will be created if no ID is supplied.","example":"cus_dev_abc123","title":"Customer Id"},"line_items":{"description":"The line items purchased by the customer.","items":{"$ref":"#/components/schemas/CreateCheckoutLineItem"},"title":"Line Items","type":"array"},"mode":{"$ref":"#/components/schemas/CheckoutMode","description":"The mode of the Checkout Session. Possible values: payment (one-time payments), setup (collect payment info), subscription (recurring payments).","example":"payment"},"return_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session.","example":"https://yourwebsite.com/payment/abc123?status=returned","title":"Return Url"},"success_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL to which OpenPay should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded.","example":"https://yourwebsite.com/payment/abc123?status=success","title":"Success Url"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime representing the end of the trial period the customer will get before being charged for the first time.","title":"Trial End"},"trial_from_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates if a price's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. In case of subscription containing multiple prices and the trial period of them are not same, minimum of trial days will be used.","example":false,"title":"Trial From Price"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a price","example":30,"title":"Trial Period Days"}},"required":["mode"],"title":"CreateCheckoutSessionRequest","type":"object"},"CreateCouponRequest":{"properties":{"amount_atom_off":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"An integer representing the amount to subtract from an invoice total. Must be >=0","title":"Amount Atom Off"},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Three-letter ISO code for the currency of the amount_atom_off parameter (required if amount_atom_off is passed)."},"duration":{"$ref":"#/components/schemas/CouponDuration","default":"once","description":"Specifies how long the discount will be in effect if used on a subscription. Defaults to once."},"duration_in_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.","title":"Duration In Months"},"is_active":{"default":true,"description":"Whether the coupon is available to be redeemed.","example":true,"title":"Is Active","type":"boolean"},"max_redemptions":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"type":"null"}],"description":"A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.","title":"Max Redemptions"},"name":{"description":"Name of the coupon displayed to customers on, for instance invoices, or receipts.","title":"Name","type":"string"},"percent_off":{"anyOf":[{"exclusiveMinimum":0,"maximum":100,"type":"integer"},{"type":"null"}],"description":"A positive int larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply","title":"Percent Off"},"product_family_ids":{"description":"An array of Product Family IDs that this Coupon can apply to.","items":{"type":"string"},"title":"Product Family Ids","type":"array"},"product_ids":{"description":"An array of Product IDs that this Coupon can apply to.","items":{"type":"string"},"title":"Product Ids","type":"array"},"redeem_by":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Datetime specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.","title":"Redeem By"},"trial_days_off":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"description":"Number of trial days that will be applied to new subscriptions.","title":"Trial Days Off"}},"required":["name"],"title":"CreateCouponRequest","type":"object"},"CreateCreditNoteLine":{"properties":{"amount_atom":{"description":"The integer amount representing the gross amount being credited for this line item.","title":"Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"invoice_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the invoice line item being credited","title":"Invoice Item Id"},"quantity":{"default":1,"title":"Quantity","type":"integer"},"type":{"$ref":"#/components/schemas/CreditNoteLineType","description":"The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice"},"unit_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The cost of each unit of product being credited.","title":"Unit Amount Atom"}},"required":["amount_atom","currency","type"],"title":"CreateCreditNoteLine","type":"object"},"CreateCreditNoteRequest":{"properties":{"credit_amount_atom":{"default":0,"description":"The integer amount representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.","title":"Credit Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd"},"invoice_id":{"description":"ID of the invoice","title":"Invoice Id","type":"string"},"lines":{"description":"Line items that make up the credit note.","items":{"$ref":"#/components/schemas/CreateCreditNoteLine"},"title":"Lines","type":"array"},"reason":{"anyOf":[{"$ref":"#/components/schemas/CreditNoteReason"},{"type":"null"}],"description":"Reason for issuing this credit note"},"refund_amount_atom":{"default":0,"description":"The integer amount representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.","title":"Refund Amount Atom","type":"integer"},"total_amount_atom":{"description":"The int amount representing the total amount of the credit note.","title":"Total Amount Atom","type":"integer"}},"required":["invoice_id","total_amount_atom","lines"],"title":"CreateCreditNoteRequest","type":"object"},"CreateCustomerBalanceTransactionRequest":{"properties":{"amount_atom":{"description":"The amount of the transaction in atomic units (in USD this is cents). A negative value is a credit for the customer’s balance, and a positive value is a debit to the customer’s balance.","title":"Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"required":["amount_atom"],"title":"CreateCustomerBalanceTransactionRequest","type":"object"},"CreateCustomerRequest":{"properties":{"billing_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing address of the customer.","title":"Billing Email"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s business name.","example":"ACME LLC","title":"Business Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City, district, suburb, town, or village.","example":"Los Angeles","title":"City"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country name. If possible two-letter country code.","example":"US","title":"Country"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If you provide a coupon_id, the customer will have a discount applied on all recurring charges. If there is an existing customer, this coupon will override it.","example":"_dev_123","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with customer.","examples":[null],"title":"Custom Fields"},"customer_billing_address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"Customer's billing address","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"email":{"description":"The customer’s email address.","example":"johndoes@xyz.com","title":"Email","type":"string"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s first name.","example":"john","title":"First Name"},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/CustomerInvoiceSettings"},{"type":"null"}],"description":"Invoice settings for the customer."},"language":{"anyOf":[{"$ref":"#/components/schemas/CustomerLanguage"},{"type":"null"}],"description":"Language of the customer."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s last name.","example":"doe","title":"Last Name"},"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 1.","example":"123 Sparrow Street","title":"Line1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 2.","example":"Unit 8","title":"Line2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 3.","example":"","title":"Line3"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Free form notes about the customer.","example":"Customer answered survey on 08-03","title":"Notes"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Phone number of the customer.","title":"Phone Number"},"promotion_code_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The API ID of a promotion code to apply to the customer. This is not PromotionCode alphabetic code. PromotionCode with restrictions cannot be redeemed on a customer. The customer will have a discount applied on all recurring payments. This is effectively same as proving Coupon attached to the promotion_code. If there is an existing customer, this will override it.","example":"promo_dev_123","title":"Promotion Code Id"},"shipping_addresses":{"default":[],"description":"List of the customer’s shipping addresses.","items":{"$ref":"#/components/schemas/CompleteAddress"},"title":"Shipping Addresses","type":"array"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State, province, or region.","example":"California","title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ZIP or postal code.","example":"90001","title":"Zip Code"}},"required":["email"],"title":"CreateCustomerRequest","type":"object"},"CreateDisputeRequest":{"properties":{"meta":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Meta"},"payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"External id of the payment intent.","example":"pi_dev_123","title":"Payment Intent Id"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason of the dispute.","title":"Reason"},"their_dispute_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"There dispute id.","example":"dp_123","title":"Their Dispute Id"},"their_payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"There payment intent id.","example":"pi_123","title":"Their Payment Intent Id"}},"title":"CreateDisputeRequest","type":"object"},"CreateInvoiceRequest":{"properties":{"collection_method":{"anyOf":[{"$ref":"#/components/schemas/CollectionMethodEnum"},{"type":"null"}],"description":"Collection method for invoice, CHARGE_AUTOMATICALLY will attempt to pay invoice immediately, SEND_INVOICE will generate but not automatically charge. If left None will be inherited from subscription.","example":"charge_automatically"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this invoice. Pass 'none' to remove discount.","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with invoice.","examples":[null],"title":"Custom Fields"},"customer_id":{"description":"The external id of the customer.","examples":["cus_dev_abc123"],"title":"Customer Id","type":"string"},"description":{"default":"Manual creation of invoice","description":"Description for newly created invoice","example":"Invoice to acme.co","title":"Description","type":"string"},"email_invoice_on_finalization":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether invoice should be sent to the customer upon finalizing the invoice.","examples":[false],"title":"Email Invoice On Finalization"},"finalize_invoice_immediately":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether invoice should be finalized immediately or not","examples":[false],"title":"Finalize Invoice Immediately"},"invoice_item_details":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/InvoiceItemDetails"},"type":"object"},{"type":"null"}],"description":"Mapping of price id's to InvoiceItemDetails objects which contain additional invoice item information","title":"Invoice Item Details"},"invoice_type":{"$ref":"#/components/schemas/InvoiceType","default":"standard","description":"The type of invoice to create. Choose standard to create the subscription based invoice and one_off to create the one-off invoices.","examples":["standard"]},"is_preview":{"default":false,"description":"Whether the request is in preview mode (Invoice won't actually be created)","examples":[false],"title":"Is Preview","type":"boolean"},"net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of days the customer has to pay the invoice, from 0 to 365, where -1 indicates due immediately. If unset, net-d from Price will apply.","example":-1,"title":"Net D"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the payment method.","example":"pm_dev_abc123","title":"Payment Method Id"},"selected_product_price_quantity":{"default":[],"description":"This object contains details of selected product' price and quantity.","example":[{"price_id":"price_dev_abc123","quantity":2}],"items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"title":"Selected Product Price Quantity","type":"array"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the subscription. The created invoice will only include pending invoice items for that subscription. The subscription’s billing cycle and regular subscription events won’t be affected.","example":"subscription_dev_abc123","title":"Subscription Id"}},"required":["customer_id"],"title":"CreateInvoiceRequest","type":"object"},"CreatePaymentLinkRequest":{"properties":{"checkout_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutPreferences"},{"type":"null"}],"description":"The checkout preferences to pass to checkout session creation."},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this payment link.","example":"coupon_dev_abc123","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach to the payment link.","title":"Custom Fields"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of an existing Customer for whom this payment link is for.","example":"cus_dev_abc123","title":"Customer Id"},"line_items":{"description":"The line items to be purchased by the customer. If empty, the checkout sessions produced by the payment link will be in \"add payment method\" mode.","items":{"$ref":"#/components/schemas/CreateCheckoutLineItem"},"title":"Line Items","type":"array"},"mode":{"$ref":"#/components/schemas/CheckoutMode","description":"The mode of the checkout sessions created by this payment link. Possible values: payment (one-time payments), setup (not supported yet), subscription (recurring payments).","example":"payment"},"success_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL to which OpenPay should send customers when payment or setup is complete.","example":"https://yourwebsite.com/payment/abc123?status=success","title":"Success Url"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime representing the end of the trial period the customer will get before being charged for the first time.","title":"Trial End"},"trial_from_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Indicates if a price’s trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. In case of subscription containing multiple prices and the trial period of them are not same, minimum of trial days will be used.","example":false,"title":"Trial From Price"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a price","example":30,"title":"Trial Period Days"}},"required":["mode","success_url"],"title":"CreatePaymentLinkRequest","type":"object"},"CreatePaymentRouteRequest":{"properties":{"name":{"description":"The name of the payment route.","example":"My Payment Route","title":"Name","type":"string"},"route_configuration":{"description":"The configuration object for the payment route. Contact the OpenPay team for more information.","title":"Route Configuration","type":"object"}},"required":["name","route_configuration"],"title":"CreatePaymentRouteRequest","type":"object"},"CreatePortalSessionRequest":{"properties":{"customer_id":{"description":"The ID of an existing customer.","example":"cust_dev_abc123","title":"Customer Id","type":"string"},"return_url":{"description":"The default URL to redirect customers to when they click on the portal\"s link to return to your website.","example":"http://example.com/account","title":"Return Url","type":"string"}},"required":["customer_id","return_url"],"title":"CreatePortalSessionRequest","type":"object"},"CreatePriceRequest":{"properties":{"aggregate_usage":{"$ref":"#/components/schemas/UsageAggMethodEnum","default":"sum","description":"Specifies a usage aggregation strategy for prices of usage_type 'metered'."},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/CalendarIntervalEnum"},{"type":"null"}],"description":"The interval unit for billing within the contract term (e.g., month, quarter).","example":"month"},"billing_interval_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of billing interval units between billing cycles.","example":3,"title":"Billing Interval Count"},"can_only_be_purchased_with":{"description":"This price can only be purchased in a subscription if subscriptioncontains at least one of these prices.","example":["price_dev_45ds7","price_dev_s8sh"],"items":{"type":"string"},"title":"Can Only Be Purchased With","type":"array"},"contract_auto_renew":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not the contract auto-renews at the end of its term.","example":true,"title":"Contract Auto Renew"},"contract_term_multiple":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Defines a multiple on top of billing_interval, billing_interval_count for which this price should be under contract for.","example":4,"title":"Contract Term Multiple"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd","description":"Three-letter ISO currency code, in lowercase."},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach to the price.","title":"Custom Fields"},"default_net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":-1,"description":"Number of days a customer has to pay invoices generated from this price.If there are mutliple prices in the invoice the minimum net-d will be respected.Value should be within -1 to 365, where -1 represents DUE_IMMEDIATELY.","example":-1,"title":"Default Net D"},"internal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing this price.","title":"Internal Description"},"is_active":{"description":"Whether the price can be used for new purchases.","example":true,"title":"Is Active","type":"boolean"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Boolean identifying if this price object is default price for the product or not.","example":true,"title":"Is Default"},"is_exclusive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"If true, this price is listed exclusively for customers in the `listed_exclusively_for_customers` field.Defaults to False (not exclusive).","example":false,"title":"Is Exclusive"},"listed_exclusively_for_customers":{"description":"When listed_exclusively_for_customers is passed only customers under listed_exclusively_for_customers can list the given price. Anyone who has a payment_link containing the price can view and subscribe the prices regardless of it.Please do not pass a value if a price is not exclusive.","example":["cus_dev_abc123","cus_dev_def456"],"items":{"type":"string"},"title":"Listed Exclusively For Customers","type":"array"},"meta":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with price.","title":"Meta"},"meter_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of meter tracking the usage of a metered price.","title":"Meter Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the price.","title":"Name"},"price_tiers":{"description":"List of price_tiers.","example":[{"flat_amount_atom":0,"unit_amount_atom":100,"units_from":1,"units_upto":10},{"unit_amount_atom":90,"units_from":11}],"items":{"$ref":"#/components/schemas/PriceTierParams"},"title":"Price Tiers","type":"array"},"price_type":{"$ref":"#/components/schemas/PriceTypeEnum","description":"One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.","example":"recurring"},"pricing_model":{"$ref":"#/components/schemas/PricingModel","description":"Indicates which pricing model to be used for product.","example":"standard"},"product_id":{"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Product Id","type":"string"},"transform_quantity_divide_by":{"default":1,"description":"This transformation will be applied on quantity before multiplying by unit_amount_atom.","title":"Transform Quantity Divide By","type":"number"},"trial_period_days":{"default":0,"description":"Number of trail days for this Price.","example":7,"title":"Trial Period Days","type":"integer"},"unit_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The unit amount in atomic units (in USD this is cents) to be charged.","example":100,"title":"Unit Amount Atom"},"usage_type":{"$ref":"#/components/schemas/UsageTypeEnum","default":"licensed","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'.","example":"licensed"}},"required":["is_active","pricing_model","price_type","product_id"],"title":"CreatePriceRequest","type":"object"},"CreateProductFamilyRequest":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A description of the product family.","example":"The best CRM catalog.","title":"Description"},"hierarchy":{"default":"{}","description":"A JSON object representing the hierarchy within the family.","example":"{\"product_abc13\": 1, \"product_abd48\": 2}","title":"Hierarchy","type":"string"},"name":{"description":"The name of the product family.","example":"CRM products","title":"Name","type":"string"},"products":{"description":"List of unique id's for the products in this family.","example":["product_abc13","product_abd48"],"items":{"type":"string"},"title":"Products","type":"array"}},"required":["name","products"],"title":"CreateProductFamilyRequest","type":"object"},"CreateProductRequest":{"properties":{"account_sku":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SKU for given product. eg. Barcode numbers of inventory item.","example":"abc123","title":"Account Sku"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with product.","examples":[null],"title":"Custom Fields"},"description":{"description":"Product's description.","example":"This is description for product1","title":"Description","type":"string"},"features":{"description":"List of product features.","example":["feature1 of product1","feature2 of product1"],"items":{"type":"string"},"title":"Features","type":"array"},"is_active":{"default":true,"description":"Whether or not this product is accepting new subscriptions.","example":true,"title":"Is Active","type":"boolean"},"name":{"description":"Name of product.","example":"product1","title":"Name","type":"string"},"unit_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label that represents units of this product.","example":"piece","title":"Unit Label"}},"required":["name","description"],"title":"CreateProductRequest","type":"object"},"CreatePromoCodeRequest":{"properties":{"code":{"description":"The customer-facing code. This code must be unique across all active promotion codes for a specific customer. Case insensitive.","title":"Code","type":"string"},"coupon_id":{"description":"The unique id of coupon for this promotion code.","title":"Coupon Id","type":"string"},"customer_ids":{"description":"List of customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.","items":{"type":"string"},"title":"Customer Ids","type":"array"},"expires_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon’s redeems_by.","title":"Expires At"},"max_redemptions":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon’s max_redemptions.","title":"Max Redemptions"},"max_redemptions_per_customer":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":1,"description":"A positive integer specifying the number of times the promotion code can be redeemed by a customer. If not set customers can redeem it multiple times.","title":"Max Redemptions Per Customer"},"restrictions":{"anyOf":[{"$ref":"#/components/schemas/PromoRestrictions"},{"type":"null"}],"description":"Settings that restrict the redemption of the promotion code."}},"required":["coupon_id","code"],"title":"CreatePromoCodeRequest","type":"object"},"CreateRefundRequest":{"properties":{"amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"amount_atom that you want to refund.","example":7000,"title":"Amount Atom"},"charge_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the charge.","example":"charge_dev_abc123","title":"Charge Id"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd","description":"Three-letter ISO currency code, in lowercase."},"description":{"default":"Manually triggered refund by admin.","description":"Description of the refund.","example":"Manually triggered refund by admin.","title":"Description","type":"string"},"payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the payment_intent. Refund will be given on the latest charge of the payment_intent.","example":"pi_dev_abc123","title":"Payment Intent Id"},"reason":{"$ref":"#/components/schemas/RefundReasonEnum","default":"manual","description":"Reason of the refund.","example":"manual"},"refunded_out_of_band":{"default":false,"description":"The charge was refunded by an external platform. This cause the request to not execute a refund externally and instead simply update internal records.","title":"Refunded Out Of Band","type":"boolean"}},"title":"CreateRefundRequest","type":"object"},"CreateSubscriptionItemRequest":{"properties":{"add_at_period_end":{"default":false,"description":"If the flag is set to True, item will be added when renewing the subscription at next billing cycle.","example":false,"title":"Add At Period End","type":"boolean"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with subscription item.","title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description for the subscription item being created.","title":"Description"},"price_id":{"description":"The ID of the price.","example":"price_dev_abc123","title":"Price Id","type":"string"},"proration_behavior":{"$ref":"#/components/schemas/ProrationEnum","default":"always_invoice","description":"Determines how to handle prorations when the billable items changes.In case of subscription is in trialing state, invoice items if any will be for amount_atom 0.","example":"always_invoice"},"quantity":{"default":1,"description":"The quantity you'd like to apply to the subscription item you're creating.","example":2,"title":"Quantity","type":"integer"},"subscription_id":{"description":"The identifier of the subscription to modify","example":"subi_dev_abc123","title":"Subscription Id","type":"string"}},"required":["subscription_id","price_id"],"title":"CreateSubscriptionItemRequest","type":"object"},"CreateSubscriptionRequest":{"properties":{"attach_to_checkout_attempt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the checkout attempt to attach the created subscriptions and invoices to.","example":"catt_dev_abc123","title":"Attach To Checkout Attempt Id"},"cancel_at_end":{"default":false,"description":"Boolean indicating whether this subscription should cancel at the end of the current period.","example":false,"title":"Cancel At End","type":"boolean"},"checkout_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutPreferences"},{"type":"null"}],"description":"Preferences for the checkout session.","examples":[null]},"collection_method":{"$ref":"#/components/schemas/CollectionMethodEnum","default":"charge_automatically","description":"Invoices generated by this subscription can either be charged automatically or can be sent to customer for payment. The latter is not automatically charged.","example":"charge_automatically"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.","example":"coupon_dev_123","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with subscription.","examples":[null],"title":"Custom Fields"},"customer_id":{"description":"Unique Identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary String describing this subscription.","example":"Description of the subscription","title":"Description"},"is_preview":{"default":false,"description":"Whether the request is in preview mode (subscriptions won't actually be created)","example":false,"title":"Is Preview","type":"boolean"},"net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of days the customer has to pay the invoice, from 0 to 365, where -1 indicates due immediately. If unset, net-d from Price will apply.","example":-1,"title":"Net D"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the default payment method for the subscription. It must belong to the customer associated with the subscription.","example":"pm_dev_abc123","title":"Payment Method Id"},"payment_route_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the payment route to use for the subscription, if any.","example":"proute_dev_abc123","title":"Payment Route Id"},"promotion_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.","example":"flat-10-pc-off","title":"Promotion Code"},"selected_product_price_quantity":{"description":"This object contains details of selected product' price and quantity.","example":[{"price_id":"price_dev_abc123","quantity":2}],"items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"title":"Selected Product Price Quantity","type":"array"},"skip_invoice_payment":{"default":false,"description":"Whether to skip invoice payment for this subscription. Setting this to true will leave the invoices open.","example":false,"title":"Skip Invoice Payment","type":"boolean"},"starts_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Pass a datetime to start subscription in future.","title":"Starts At"},"subscription_item_details":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/SubscriptionItemDetails"},"type":"object"},{"type":"null"}],"description":"Mapping of price id's to SubscriptionItemDetails objects which contain additional subscription item information","title":"Subscription Item Details"},"total_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Total due amount today, in atomic units (e.g. in USD this is cents). If provided, we will verify that this matches our calculated total for extra protection. If not provided, total validation will be skipped.","example":9000,"title":"Total Amount Atom"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime representing the end of the trial period the customer will get before being charged for the first time.","title":"Trial End"},"trial_from_price":{"default":true,"description":"Indicates if a price's trial_period_days should be applied to the subscription. Setting trial_end per subscription is preferred, and this defaults to false. Setting this flag to true together with trial_end is not allowed. In case of subscription containing multiple prices and the trial period of them are not same, minimum of trial days will be used.","example":false,"title":"Trial From Price","type":"boolean"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a price","example":30,"title":"Trial Period Days"}},"required":["customer_id","selected_product_price_quantity"],"title":"CreateSubscriptionRequest","type":"object"},"CreateSubscriptionResponse":{"properties":{"created":{"description":"List of subscriptions created.","example":[{"account_id":"account_dev_abc123","cancel_at_end":false,"cancellation_details":{},"current_period_end":"2023-11-02T08:49:54.678156Z","current_period_start":"2023-10-02T08:49:54.678156Z","customer_id":"cus_dev_abc123","default_payment_method_id":"pm_dev_abc123","description":"Description of this subcription.","id":"subscription_dev_abc123","initial_start":"2023-10-02T08:49:54.678156Z","status":"active","subscription_items":[{"deleted":false,"id":"subi_dev_abc123","price_id":"price_dev_abc123","quantity":2,"subscription_id":"subscription_dev_abc123"}]}],"items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Created","type":"array"},"invoices":{"description":"List of invoices created","items":{"$ref":"#/components/schemas/InvoiceExternal"},"title":"Invoices","type":"array"},"processors_used":{"description":"List of successful processor IDs used for creating the subscriptions","items":{"type":"string"},"title":"Processors Used","type":"array"}},"required":["created","invoices","processors_used"],"title":"CreateSubscriptionResponse","type":"object"},"CreateTaxIntegrationRequest":{"properties":{"accounting_tz":{"description":"The timezone name for the accounting timezone (see pytz.all_timezones for a full list)","example":"US/Pacific","title":"Accounting Tz","type":"string"},"api_keys":{"additionalProperties":{"type":"string"},"description":"These keys will allow to authenticate API requests to the tax processor.","example":{"api_key":"00000000000/aaaaaaaaaaaaa/secret.ZZZZZZZZZZZZZZZZZZZZZZZZZZ"},"title":"Api Keys","type":"object"},"api_name":{"$ref":"#/components/schemas/TaxIntegrationApiName","description":"The name of the API used for the tax integration.","example":"anrok_v1"}},"required":["api_name","api_keys","accounting_tz"],"title":"CreateTaxIntegrationRequest","type":"object"},"CreditNoteExternal":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"credit_amount_atom":{"description":"The integer amount representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice. It is in atomic units (in USD this is cents).","example":5000,"title":"Credit Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"id":{"description":"Unique Identifier of the credit_note.","example":"credit_note_dev_abc123","title":"Id","type":"string"},"invoice_id":{"description":"Unique ID of the invoice.","example":"invoice_dev_abc123","title":"Invoice Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"items":{"description":"List of credit_note_items.","example":[{"amount_atom":5000,"currency":"usd","id":"cnl_dev_abc123","invoice_item_id":"invoiceitem_dev_abc123","quantity":2,"type":"invoice_line_item","unit_amount_atom":2500}],"items":{"$ref":"#/components/schemas/CreditNoteItemExternal"},"title":"Items","type":"array"},"object":{"$ref":"#/components/schemas/ObjectName","default":"credit_note"},"reason":{"anyOf":[{"$ref":"#/components/schemas/CreditNoteReason"},{"type":"null"}],"description":"Reason for issuing this credit note","example":"order_change"},"refund_amount_atom":{"description":"The integer amount representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. It is in atomic units (in USD this is cents).","example":0,"title":"Refund Amount Atom","type":"integer"},"total_amount_atom":{"description":"The integer amount representing the total amount of the credit note. It is in atomic units (in USD this is cents).","example":5000,"title":"Total Amount Atom","type":"integer"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","total_amount_atom","currency","reason","invoice_id","items","credit_amount_atom","refund_amount_atom"],"title":"CreditNoteExternal","type":"object"},"CreditNoteItemExternal":{"properties":{"amount_atom":{"description":"The integer amount representing the gross amount being credited for this credit_note_item. It is in atomic units (in USD this is cents).","example":5000,"title":"Amount Atom","type":"integer"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"id":{"description":"Unique Identifier of the credit_note_item.","example":"cnl_dev_abc123","title":"Id","type":"string"},"invoice_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the invoice line item being credited","example":"invoiceitem_dev_abc123","title":"Invoice Item Id"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"credit_note_item"},"quantity":{"default":1,"description":"Quantity of the product being credited.","example":2,"title":"Quantity","type":"integer"},"type":{"$ref":"#/components/schemas/CreditNoteLineType","description":"The type of the credit note line item, one of invoice_line_item or custom_line_item. When the type is invoice_line_item there is an additional invoice_line_item property on the resource the value of which is the id of the credited line item on the invoice.","example":"invoice_line_item"},"unit_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The cost of each unit of product being credited. It is in atomic units (in USD this is cents).","example":2500,"title":"Unit Amount Atom"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_atom","currency","type"],"title":"CreditNoteItemExternal","type":"object"},"CreditNoteLineType":{"enum":["invoice_line_item","custom_line_item"],"title":"CreditNoteLineType","type":"string"},"CreditNoteQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only return credit notes for the customer specified by this customer ID.","examples":["cus_dev_abc123"],"title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only return credit notes for the invoice specified by this invoice ID.","examples":["invoice_dev_abc123"],"title":"Invoice Id"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"CreditNoteQueryParams","type":"object"},"CreditNoteReason":{"enum":["duplicate","fraudulent","order_change","product_unsatisfactory"],"title":"CreditNoteReason","type":"string"},"CurrencyEnum":{"enum":["usd","brl","eur","gbp","aud","cad","nok","sek","mxn","inr","ars","cop","clp","nzd","jpy","chf","cny","hkd","sgd","pln","dkk","zar","thb","myr","ils","php","try","idr","czk","aed","sar","rub","all","amd","ang","aoa","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bob","bsd","bwp","bzd","crc","cve","djf","dop","dzd","egp","etb","fjd","fkp","gel","gip","gmd","gnf","gtq","gyd","hnl","huf","jmd","kes","kgs","khr","kmf","krw","kyd","kzt","lak","lbp","lkr","lrd","lsl","mad","mdl","mkd","mnt","mop","mur","mvr","mwk","nad","ngn","nio","npr","pab","pen","pgk","pkr","pyg","qar","ron","rsd","rwf","sbd","scr","shp","srd","std","szl","tjs","top","ttd","twd","tzs","uah","ugx","uyu","uzs","vnd","vuv","wst","xaf","xcd","xof","xpf","zmw"],"title":"CurrencyEnum","type":"string"},"CustomerBalanceExternal":{"properties":{"amount_atom":{"title":"Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"}},"required":["currency","amount_atom"],"title":"CustomerBalanceExternal","type":"object"},"CustomerBalanceTransactionExternal":{"properties":{"amount_atom":{"title":"Amount Atom","type":"integer"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"credit_note_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Note Id"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"ending_balance_amount_atom":{"title":"Ending Balance Amount Atom","type":"integer"},"id":{"title":"Id","type":"string"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"customer_balance_transaction"},"type":{"$ref":"#/components/schemas/CustomerBalanceTransactionType"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_atom","currency","ending_balance_amount_atom","type","invoice_id","credit_note_id","description"],"title":"CustomerBalanceTransactionExternal","type":"object"},"CustomerBalanceTransactionType":{"description":"refer https://stripe.com/docs/billing/customer/balance#types","enum":["adjustment","applied_to_invoice","credit_note","initial","invoice_overpaid","invoice_too_large","invoice_too_small","unspent_receiver_credit","unapplied_from_invoice"],"title":"CustomerBalanceTransactionType","type":"string"},"CustomerExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"Customer's full address","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"balance_atoms":{"default":[],"description":"List of the customer's balance in the smallest unit of currency (e.g., cents for USD). Positive values indicate the amount owed by the customer, to be applied to the next invoice. Negative values represent credit to apply to future invoices.","items":{"$ref":"#/components/schemas/CustomerBalanceExternal"},"title":"Balance Atoms","type":"array"},"billing_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing email of the customer.","title":"Billing Email"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Customer's business name.","example":"ACME LLC","title":"Business Name"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the customer. This can be useful to store the additional data related to the customer.","title":"Custom Fields"},"customer_billing_address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"Customer's billing address","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"discount":{"anyOf":[{"$ref":"#/components/schemas/DiscountExternal"},{"type":"null"}],"description":"Describes the current discount active on the customer, if there is one."},"email":{"description":"Customer's email address.","example":"johndoe@xyz.com","title":"Email","type":"string"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Customer's first name.","example":"John","title":"First Name"},"id":{"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Id","type":"string"},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/CustomerInvoiceSettings"},{"type":"null"}],"description":"Invoice settings for the customer."},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"language":{"$ref":"#/components/schemas/CustomerLanguage","default":"en","description":"Language of the customer."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Customer's last name.","example":"Doe","title":"Last Name"},"last_successful_payment_intent":{"anyOf":[{"$ref":"#/components/schemas/PaymentIntentExternal"},{"type":"null"}],"description":"The last payment intent made by the customer, if there is one."},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"mrr":{"default":[],"description":"The monthly recurring revenue of the customer broken down by currency.","items":{"$ref":"#/components/schemas/CustomerTotalAmount"},"title":"Mrr","type":"array"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Free form notes","example":"Customer answered survey on 08-03","title":"Notes"},"object":{"$ref":"#/components/schemas/ObjectName","default":"customer"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Phone number of the customer.","title":"Phone Number"},"shipping_addresses":{"default":[],"description":"List of customer's shipping addresses.","items":{"$ref":"#/components/schemas/CompleteAddress"},"title":"Shipping Addresses","type":"array"},"should_send_payment_receipt":{"description":"Whether email should be sent or not on payment.","examples":[true],"title":"Should Send Payment Receipt","type":"boolean"},"status":{"anyOf":[{"$ref":"#/components/schemas/CustomerStatus"},{"type":"null"}],"description":"Status of the customer.","examples":[null]},"subscribed_to_products":{"default":[],"description":"List of products that the customer is subscribed to.","items":{"$ref":"#/components/schemas/ProductExternal"},"title":"Subscribed To Products","type":"array"},"subscriptions":{"description":"List of customer's subscriptions.","example":[],"items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Subscriptions","type":"array"},"total_refunds":{"default":[],"description":"The total amount refunded to the customer.","items":{"$ref":"#/components/schemas/CustomerTotalAmount"},"title":"Total Refunds","type":"array"},"total_spent":{"default":[],"description":"The total amount spent by the customer.","items":{"$ref":"#/components/schemas/CustomerTotalAmount"},"title":"Total Spent","type":"array"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","account_id","email","first_name","last_name","business_name","address","notes","should_send_payment_receipt"],"title":"CustomerExternal","type":"object"},"CustomerInvoiceSettings":{"properties":{"customer_tax_ids":{"description":"The tax IDs of the customer.","example":[{"tax_id":"12-3456789","tax_id_type":"us_ein"}],"items":{"$ref":"#/components/schemas/TaxIdSetting"},"title":"Customer Tax Ids","type":"array"},"default_net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Default number of days after the invoice date that the invoice is due.","example":30,"title":"Default Net D"},"email_receipt_on_paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether receipt email should be sent or not to the customer. This will override account level email_receipt_on_paid setting.","title":"Email Receipt On Paid"}},"title":"CustomerInvoiceSettings","type":"object"},"CustomerLanguage":{"enum":["en","en_us","pt","es","de","fr","it","nl","ro","zh","zh_hk","zh_tw","ru","ja","ko","ar","tr","hi"],"title":"CustomerLanguage","type":"string"},"CustomerPaymentMethodQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"provider_type":{"anyOf":[{"$ref":"#/components/schemas/PaymentProviderType"},{"type":"null"}],"description":"Filter by the payment provider type."},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"CustomerPaymentMethodQueryParams","type":"object"},"CustomerQueryParams":{"properties":{"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coupon id which is applied to a customer.","title":"Coupon Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email Address of the customer.","title":"Email"},"emails":{"default":[],"description":"List of customer email address.","items":{"type":"string"},"title":"Emails","type":"array"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Search for customers against their email address, first name and last name"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"CustomerQueryParams","type":"object"},"CustomerStatus":{"enum":["active","inactive","trialing","cancelled"],"title":"CustomerStatus","type":"string"},"CustomerTotalAmount":{"properties":{"amount_atom":{"default":0,"description":"The total refunds/spent of the customer.","title":"Amount Atom","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"The currency of the total amount."}},"required":["currency"],"title":"CustomerTotalAmount","type":"object"},"DateTimeFilter":{"properties":{"eq":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Field values Date should be equal to this values Date.This value is used to filter records for a specific date(day level).","title":"Eq"},"gt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Field value greater than this value.","title":"Gt"},"gte":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Field value greater or equal to this value.","title":"Gte"},"lt":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Field value less than this value.","title":"Lt"},"lte":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Field value less than or equal to this value.","title":"Lte"}},"title":"DateTimeFilter","type":"object"},"DeleteInvoiceItemResponse":{"properties":{"invoice_item_id":{"description":"Unique identifier of the invoice_item.","example":"invoiceitem_dev_abc123","title":"Invoice Item Id","type":"string"},"message":{"default":"Invoice Item Deleted successfully.","description":"Message describing result of API call.","example":"Invoice Item Deleted successfully.","title":"Message","type":"string"}},"required":["invoice_item_id"],"title":"DeleteInvoiceItemResponse","type":"object"},"DeletePaymentRouteResponse":{"properties":{"message":{"default":"Payment route deleted successfully","description":"Message describing result of API call.","example":"Payment route deleted successfully","title":"Message","type":"string"},"payment_route_id":{"description":"Unique identifier of the payment route.","example":"proute_dev_abc123","title":"Payment Route Id","type":"string"}},"required":["payment_route_id"],"title":"DeletePaymentRouteResponse","type":"object"},"DeletePriceResponse":{"properties":{"message":{"default":"Price deleted Successfully.","description":"Message describing result of API call.","title":"Message","type":"string"},"price_id":{"description":"Unique identifier of the price.","example":"price_dev_abc123","title":"Price Id","type":"string"}},"required":["price_id"],"title":"DeletePriceResponse","type":"object"},"DeleteProductResponse":{"properties":{"message":{"default":"Product deleted Successfully.","description":"Message describing result of API call.","example":"Product deleted Successfully.","title":"Message","type":"string"},"product_id":{"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Product Id","type":"string"}},"required":["product_id"],"title":"DeleteProductResponse","type":"object"},"DeleteSubscriptionItemRequest":{"properties":{"drop_at_end":{"default":true,"description":"Whether or not this item will be dropped from subscription before next renewal","title":"Drop At End","type":"boolean"},"proration_behavior":{"$ref":"#/components/schemas/ProrationEnum","default":"always_invoice","description":"Determines how to handle prorations while deleting item.In case of subscription is in trialing state, invoice items if any will be for amount_atom 0.","example":"always_invoice"}},"title":"DeleteSubscriptionItemRequest","type":"object"},"DeleteSubscriptionItemResponse":{"properties":{"deleted_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"If deleted, then this is the 'ISO 8601' of when it was deleted","example":false,"title":"Deleted At"},"drop_at_end":{"default":false,"description":"Whether or not this item will be dropped from subscription before next renewal","example":false,"title":"Drop At End","type":"boolean"},"message":{"default":"SubscriptionItem deleted successfully.","description":"Message describing result of API call.","example":"SubscriptionItem deleted successfully.","title":"Message","type":"string"},"subscription_item_id":{"description":"Unique identifier of the subscription_item.","example":"subi_dev_abc123","title":"Subscription Item Id","type":"string"}},"required":["subscription_item_id","deleted_at"],"title":"DeleteSubscriptionItemResponse","type":"object"},"DeleteSubscriptionRequest":{"properties":{"cancel_unpaid_invoices":{"default":false,"description":"Mark unpaid invoices as uncollectible","examples":[true,false],"title":"Cancel Unpaid Invoices","type":"boolean"},"cancellation_details":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionCancellationDetails"},{"type":"null"}],"description":"Details about why this subscription was canceled","example":{"comment":"Comment for the subscription.","feedback":"unused","reason":"Canceled at period end."}},"full_refund":{"default":false,"description":"Flag to decide whether full refund should be given or not.","example":false,"title":"Full Refund","type":"boolean"},"is_preview":{"default":false,"description":"Whether the request is in preview mode (subscriptions won't actually be deleted)","example":false,"title":"Is Preview","type":"boolean"},"prorate":{"default":true,"description":"Will generate a proration invoice_item that credits remaining unused time until the subscription period end, also creates invoice_item for un-invoiced metered usage.Setting this to false will not invoice for un-invoiced metered usage.","example":false,"title":"Prorate","type":"boolean"}},"title":"DeleteSubscriptionRequest","type":"object"},"DeleteSubscriptionResponse":{"properties":{"invoice":{"anyOf":[{"$ref":"#/components/schemas/InvoiceExternal"},{"type":"null"}],"description":"Subscription cancellation invoice, available when create proration is true."},"subscription":{"$ref":"#/components/schemas/SubscriptionExternal","description":"Deleted subscription."}},"required":["subscription"],"title":"DeleteSubscriptionResponse","type":"object"},"DiscountExternal":{"properties":{"coupon":{"$ref":"#/components/schemas/CouponExternal"},"coupon_id":{"title":"Coupon Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"end_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"End Date"},"id":{"title":"Id","type":"string"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"invoice_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Item Id"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"discount"},"promotion_code":{"anyOf":[{"$ref":"#/components/schemas/PromotionCodeExternal"},{"type":"null"}]},"promotion_code_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Promotion Code Id"},"start_date":{"format":"date-time","title":"Start Date","type":"string"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscription Id"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","start_date","end_date","coupon_id","coupon","customer_id","subscription_id","invoice_id","invoice_item_id","promotion_code_id","promotion_code"],"title":"DiscountExternal","type":"object"},"DisputeExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique identifier of the dispute.","example":"dispute_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"object":{"$ref":"#/components/schemas/ObjectName","default":"dispute"},"payment_intent_id":{"description":"The payment intent id.","example":"pi_dev_abc123","title":"Payment Intent Id","type":"string"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reason of a dispute.","title":"Reason"},"their_dispute_id":{"description":"There dispute id.","title":"Their Dispute Id","type":"string"},"their_payment_intent_id":{"description":"Their payment intent id","title":"Their Payment Intent Id","type":"string"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","their_dispute_id","account_id","payment_intent_id","their_payment_intent_id"],"title":"DisputeExternal","type":"object"},"EnumConfigField":{"properties":{"default_value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The default value of the enum.","title":"Default Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The description of the field.","title":"Description"},"key":{"description":"The key of the field in the config.","title":"Key","type":"string"},"name":{"description":"The name of the field.","title":"Name","type":"string"},"options":{"description":"The options for the enum.","items":{"type":"string"},"title":"Options","type":"array"},"type":{"const":"enum","default":"enum","title":"Type","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value of the field.","title":"Value"}},"required":["name","key","value","options"],"title":"EnumConfigField","type":"object"},"EventExternal":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"data":{"title":"Data","type":"object"},"data_previous":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Data Previous"},"id":{"title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"event"},"pending_webhooks":{"title":"Pending Webhooks","type":"integer"},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Id"},"request_idempotency_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Idempotency Key"},"type":{"$ref":"#/components/schemas/EventType"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"}},"required":["id","created_at","updated_at","account_id","type","data","data_previous","request_id","request_idempotency_key","pending_webhooks"],"title":"EventExternal","type":"object"},"EventRetriggerRequest":{"properties":{"event_id":{"description":"Unique id for the event which you would like to re-retigger.","example":"event_dev_abc123","title":"Event Id","type":"string"},"selected_webhooks":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"description":"Optional list of webhook ids to which you want to send the event. If left blank the event will be sent to each webhook registered for the event type.","title":"Selected Webhooks"}},"required":["event_id"],"title":"EventRetriggerRequest","type":"object"},"EventRetriggerResponse":{"properties":{"webhook_delivery_results":{"additionalProperties":{"$ref":"#/components/schemas/WebhookDeliveryResult"},"description":"Mapping from webhook id to the delivery results","title":"Webhook Delivery Results","type":"object"}},"required":["webhook_delivery_results"],"title":"EventRetriggerResponse","type":"object"},"EventSearchParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"limit":{"default":50,"description":"Maximum number of documents to retrieve.","title":"Limit","type":"integer"},"object_id":{"description":"Unique ID of the object.","title":"Object Id","type":"string"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"types":{"description":"An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property.","items":{"$ref":"#/components/schemas/EventType"},"title":"Types","type":"array"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"required":["object_id"],"title":"EventSearchParams","type":"object"},"EventType":{"enum":["all","account.created","account.updated","account.deleted","api_token.created","api_token.updated","api_token.deleted","charge.created","charge.updated","charge.deleted","charge.succeeded","charge.failed","charge.pending","charge.refunded","coupon.created","coupon.updated","coupon.deleted","credit_note.created","credit_note.updated","credit_note.deleted","customer.created","customer.updated","customer.deleted","customer_balance_transaction.created","customer_balance_transaction.updated","customer_balance_transaction.deleted","discount.created","discount.updated","discount.deleted","invite.created","invite.updated","invite.deleted","invite_item_discount.created","invite_item_discount.updated","invite_item_discount.deleted","invoice.created","invoice.updated","invoice.finalized","invoice.paid","invoice.past_due","invoice.voided","invoice.uncollectible","invoice.deleted","invoice.upcoming","invoice_discount.created","invoice_discount.updated","invoice_discount.deleted","invoice_item.created","invoice_item.updated","invoice_item.deleted","payment_intent.created","payment_intent.updated","payment_intent.deleted","payment_intent.succeeded","payment_intent.processing","payment_intent.requires_action","payment_intent.failed","payment_method.created","payment_method.updated","payment_method.deleted","payment_processor.created","payment_processor.updated","payment_processor.deleted","price.created","price.updated","price.deleted","product.created","product.updated","product.deleted","promotion_code.created","promotion_code.updated","promotion_code.deleted","refund.created","refund.updated","refund.deleted","customer.subscription.created","customer.subscription.updated","customer.subscription.deleted","customer.subscription.canceled","customer.subscription.activated","customer.subscription.paused","customer.subscription.resumed","customer.subscription.past_due","customer.subscription.trialing","customer.subscription.trial_will_end","subscription_item.created","subscription_item.updated","subscription_item.deleted","user.created","user.updated","user.deleted","user_login.created","user_login.updated","user_login.deleted","user_record.created","user_record.updated","user_record.deleted","user_record_summary.created","user_record_summary.updated","user_record_summary.deleted","webhook_endpoint.created","webhook_endpoint.updated","webhook_endpoint.deleted","checkout_session.created","checkout_session.completed","checkout_session.expired"],"title":"EventType","type":"string"},"EventsQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"delivery_success":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.","title":"Delivery Success"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"types":{"description":"An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property.","items":{"$ref":"#/components/schemas/EventType"},"title":"Types","type":"array"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"EventsQueryParams","type":"object"},"FallbackConfiguration-Input":{"properties":{"fallback_processor_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutProcessorsPreferences"},{"type":"null"}],"description":"Processor preferences for the checkout session."},"price_groups":{"default":[],"description":"List of price groups that will be used to fall back to if the selected product price quantity fails to be created.","items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"title":"Price Groups","type":"array"}},"title":"FallbackConfiguration","type":"object"},"FallbackConfiguration-Output":{"properties":{"fallback_processor_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutProcessorsPreferences"},{"type":"null"}],"description":"Processor preferences for the checkout session."},"price_groups":{"default":[],"description":"List of price groups that will be used to fall back to if the selected product price quantity fails to be created.","items":{"$ref":"#/components/schemas/SelectedPriceQuantity"},"title":"Price Groups","type":"array"}},"title":"FallbackConfiguration","type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"InlineSubscriptionItemUpdate":{"properties":{"add_at_period_end":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"If the flag is set to True, item will be added when renewing the subscription at next billing cycle.","title":"Add At Period End"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with subscription item.","title":"Custom Fields"},"delete":{"default":false,"description":"A flag that, if set to true, will delete the specified item immediately from subscription. drop_at_end flag cannot be used while using this behaviour","title":"Delete","type":"boolean"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the subcription item","title":"Description"},"drop_at_end":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A flag that, if set to true, will drop the subscription item from subscription when renewing subscription. delete flag cannot be used while using this behaviour","title":"Drop At End"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Subscription item to update. If skipped a new subscription item will be created","title":"Id"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the price. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.","title":"Price Id"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Updated quantity for this item.","title":"Quantity"},"starts_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The datetime when the subscription item updates start. Defaults to now if unset.","title":"Starts At"}},"title":"InlineSubscriptionItemUpdate","type":"object"},"IntRangeFilter":{"properties":{"eq":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Field value equal to this value.","title":"Eq"},"gt":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Field value greater than this value.","title":"Gt"},"gte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Field value greater or equal to this value.","title":"Gte"},"lt":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Field value less than this value.","title":"Lt"},"lte":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Field value less than or equal to this value.","title":"Lte"}},"title":"IntRangeFilter","type":"object"},"InvoiceComment":{"properties":{"comment":{"description":"Status update.","title":"Comment","type":"string"},"created_at":{"description":"Creation date of the comment.","format":"date-time","title":"Created At","type":"string"},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The email address of the commentator.","title":"User Email"}},"required":["comment","created_at","user_email"],"title":"InvoiceComment","type":"object"},"InvoiceDiscountAmountsExternal":{"properties":{"amount_atom":{"description":"Amount in units of atom (for usd that is cents, e.g. 1200 for $12)","title":"Amount Atom","type":"integer"},"discount_id":{"description":"Id of the discount that was applied to get this discount amount.","title":"Discount Id","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"invoice_discount"}},"required":["discount_id","amount_atom"],"title":"InvoiceDiscountAmountsExternal","type":"object"},"InvoiceExternal":{"properties":{"account_id":{"description":"Unique identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"applied_balance_amount_atom":{"description":"Amount applied from customer balance either from credit or debit. It is in atomic units (in USD this is cents).","example":500,"title":"Applied Balance Amount Atom","type":"integer"},"billing_reason":{"$ref":"#/components/schemas/BillingReasonEnum","description":"Indicates the reason why the invoice was created.","example":"subscription_create"},"collection_method":{"$ref":"#/components/schemas/CollectionMethodEnum","description":"Indicates method of payment collection of the invoice.","example":"charge_automatically"},"comments":{"description":"The history of the status updates.","example":[{"comment":"Marked as paid","created_at":"2023-11-04T19:31:08.650160Z","user_email":"user@email.com"}],"items":{"$ref":"#/components/schemas/InvoiceComment"},"title":"Comments","type":"array"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"credit_note_ids":{"description":"List of unique identifiers of all the credit notes issued for this invoice.","example":["credit_note_dev_abc123"],"items":{"type":"string"},"title":"Credit Note Ids","type":"array"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the invoice. This can be useful to store the additional data related to the invoice.","title":"Custom Fields"},"customer":{"anyOf":[{"$ref":"#/components/schemas/CustomerExternal"},{"type":"null"}],"description":"Details of the customer."},"customer_id":{"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id","type":"string"},"customer_tax_ids":{"description":"The tax ID settings of the customer.","example":[{"tax_id":"12-3456789","tax_id_type":"us_ein"}],"items":{"$ref":"#/components/schemas/TaxIdSetting"},"title":"Customer Tax Ids","type":"array"},"default_payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the payment_method.","example":"xyz","title":"Default Payment Method Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing the invoice for user.","example":"This is invoice description.","title":"Description"},"discounts":{"description":"The discounts applied to the invoice.","items":{"$ref":"#/components/schemas/DiscountExternal"},"title":"Discounts","type":"array"},"due_amount_atom":{"description":"Final amount due at this time for this invoice. It isin atomic units (in USD this is cents).","example":8950,"title":"Due Amount Atom","type":"integer"},"due_date":{"description":"Due date to pay the invoice.","format":"date-time","title":"Due Date","type":"string"},"email_invoice_on_finalization":{"default":false,"description":"Whether invoice should be sent to the customer upon finalizing the invoice","examples":[false],"title":"Email Invoice On Finalization","type":"boolean"},"hosted_invoice_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.","title":"Hosted Invoice Url"},"id":{"description":"Unique identifier of the invoice.","example":"invoice_dev_abc123","title":"Id","type":"string"},"invoice_number":{"description":"Invoice number","title":"Invoice Number","type":"integer"},"invoice_pdf_url":{"description":"The URL for the Invoice PDF","title":"Invoice Pdf Url","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"is_initial_invoice_for_trial_sub":{"description":"Whether this is the first invoice for a trial subscription.","title":"Is Initial Invoice For Trial Sub","type":"boolean"},"latest_payment_attempt_failure_message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Human readable failure message of latest payment attempt, if any.","title":"Latest Payment Attempt Failure Message"},"latest_payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the payment_intent.","example":"xyz","title":"Latest Payment Intent Id"},"lines":{"description":"List of individual line items that make up the invoice.","example":[{"account_id":"account_dev_abc123","amount_atom":200,"created_at":"2023-11-04T19:31:07.333298Z","currency":"usd","customer_id":"cus_dev_abc123","description":"This is invoice description.","id":"invoiceitem_dev_abc123","invoice_id":"invoice_dev_abc123","name":"Invoice 1","period_end":"2023-11-04T19:31:08.650160Z","period_start":"2023-11-04T19:31:08.650160Z","price_id":"price_dev_abc123","quantity":2,"subscription_id":"subscription_dev_abc123","subscription_item_id":"subi_dev_abc123","total_discount_amount_atoms":[{"amount_atom":50,"discount_id":"discount_dev_123"}],"updated_at":"2023-11-04T19:31:50.333298Z"}],"items":{"$ref":"#/components/schemas/InvoiceItemExternal"},"title":"Lines","type":"array"},"merchant_tax_ids":{"description":"The tax ID settings of the merchant.","example":[{"is_default":true,"tax_id":"DE123456789","tax_id_type":"eu_vat"}],"items":{"$ref":"#/components/schemas/MerchantTaxIdSetting"},"title":"Merchant Tax Ids","type":"array"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"metadata","title":"Metadata"},"net_d":{"default":-1,"description":"Number of days the customer has to pay the invoice, from 0 to 365, where -1 indicates due immediately.","example":30,"title":"Net D","type":"integer"},"object":{"$ref":"#/components/schemas/ObjectName","default":"invoice"},"paid_amount_atom":{"description":"The amount that was paid in atomic units (in USD this is cents).","example":6000,"title":"Paid Amount Atom","type":"integer"},"paid_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"When the invoice was paid, in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","title":"Paid At"},"paid_out_of_band":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Boolean representing whether an invoice is paid outside of OpenPay.","title":"Paid Out Of Band"},"period_end":{"description":"End of the usage period during which invoice_items were added to this invoice. It is in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","format":"date-time","title":"Period End","type":"string"},"period_start":{"description":"Start of the usage period during which invoice_items were added to this invoice. It is in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","format":"date-time","title":"Period Start","type":"string"},"post_payment_credit_notes_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Total amount of all post-payment credit notes issued for this invoice.","example":3000,"title":"Post Payment Credit Notes Amount"},"pre_payment_credit_notes_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Total amount of all pre-payment credit notes issued for this invoice.","example":2000,"title":"Pre Payment Credit Notes Amount"},"provider_type_fee_amount_atom":{"description":"Total fee amount charged for the payment provider type in atomic units.","example":900,"title":"Provider Type Fee Amount Atom","type":"integer"},"receipt_pdf_url":{"description":"The URL for the Receipt PDF","title":"Receipt Pdf Url","type":"string"},"refund_ids":{"description":"Ids of refund object for this invoice.","items":{"type":"string"},"title":"Refund Ids","type":"array"},"refunded_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Amount refunded to customer in source payment method. This does not involve credits to customer balance.","title":"Refunded Amount Atom"},"remaining_amount_atom":{"description":"Remaining amount of the invoice to be paid. It is in atomic units (in USD this is cents).","example":0,"title":"Remaining Amount Atom","type":"integer"},"status":{"$ref":"#/components/schemas/InvoiceStatusEnum","description":"Status of the invoice.","example":"paid"},"subscription":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionExternal"},{"type":"null"}],"description":"Details of the subscription."},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the subscription.","example":"subscription_dev_abc123","title":"Subscription Id"},"tax_amount_atom":{"description":"Total tax amount in atomic units.","example":900,"title":"Tax Amount Atom","type":"integer"},"tax_processor_updated_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"When the tax processor was last updated successfully with this invoice","title":"Tax Processor Updated At"},"total_amount_atom":{"description":"Total amount of the invoice. Sum of invoice_items' total amount. It is in atomic units (in USD this is cents).","example":9000,"title":"Total Amount Atom","type":"integer"},"total_discount_amount_atoms":{"description":"The aggregate amount_atoms calculated per discount across all line items.","example":[{"amount_atom":50,"discount_id":"discount_dev_123"}],"items":{"$ref":"#/components/schemas/InvoiceDiscountAmountsExternal"},"title":"Total Discount Amount Atoms","type":"array"},"total_excluding_taxes_amount_atom":{"description":"Total amount excluding taxes. It is in atomic units (in USD this is cents).","example":8000,"title":"Total Excluding Taxes Amount Atom","type":"integer"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","account_id","billing_reason","collection_method","customer_id","currency","due_date","period_end","period_start","status","paid_out_of_band","total_amount_atom","remaining_amount_atom","tax_amount_atom","provider_type_fee_amount_atom","lines","applied_balance_amount_atom","due_amount_atom","paid_amount_atom","refund_ids","refunded_amount_atom","invoice_pdf_url","receipt_pdf_url","is_initial_invoice_for_trial_sub","invoice_number","total_excluding_taxes_amount_atom"],"title":"InvoiceExternal","type":"object"},"InvoiceItemDetails":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"title":"InvoiceItemDetails","type":"object"},"InvoiceItemDiscountAmountsExternal":{"properties":{"amount_atom":{"description":"The amount_atom, of the discount.","title":"Amount Atom","type":"integer"},"discount_id":{"description":"Id of the discount that was applied to get this discount amount.","title":"Discount Id","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"invoice_item_discount"}},"required":["discount_id","amount_atom"],"title":"InvoiceItemDiscountAmountsExternal","type":"object"},"InvoiceItemDiscountAmountsPublic":{"properties":{"amount_atom":{"description":"The amount_atom of the discount.","title":"Amount Atom","type":"integer"},"coupon_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the coupon that was applied to get this discount.","example":"10% off","title":"Coupon Description"},"coupon_name":{"description":"Name of the coupon that was applied to get this discount.","title":"Coupon Name","type":"string"}},"required":["amount_atom","coupon_name"],"title":"InvoiceItemDiscountAmountsPublic","type":"object"},"InvoiceItemExternal":{"properties":{"account_id":{"description":"Unique identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"amount_atom":{"description":"Total amount of invoice_item in atomic units (in USD this is cents).","example":200,"title":"Amount Atom","type":"integer"},"amount_atom_considering_discount_applied":{"description":"Total amount of invoice_item in atomic units considering discounts. Contains both invoice-level and invoice item-level discounts","example":150,"title":"Amount Atom Considering Discount Applied","type":"integer"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"customer_id":{"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing the invoice_item for user.","example":"This is invoice description.","title":"Description"},"discount_amount_atoms":{"description":"The amount_atom of all discount.","example":[{"amount_atom":50,"discount_id":"discount_dev_123"}],"items":{"$ref":"#/components/schemas/InvoiceItemDiscountAmountsExternal"},"title":"Discount Amount Atoms","type":"array"},"discounts":{"description":"The discounts only directly applied to the InvoiceItem.","example":[],"items":{"type":"string"},"title":"Discounts","type":"array"},"id":{"description":"Unique identifier of the invoice_item.","example":"invoiceitem_dev_abc123","title":"Id","type":"string"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the invoice.","example":"invoice_dev_abc123","title":"Invoice Id"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"name":{"description":"Name of the invoice_item.","example":"Invoice 1","title":"Name","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"invoice_item"},"period_end":{"description":"End of the usage period of the invoice_item. It is in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","format":"date-time","title":"Period End","type":"string"},"period_start":{"description":"Start of the usage period of the invoice_item. It is in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","format":"date-time","title":"Period Start","type":"string"},"price_id":{"description":"Unique identifier of the price.","example":"price_dev_abc123","title":"Price Id","type":"string"},"price_type":{"$ref":"#/components/schemas/PriceTypeEnum","description":"Type of the price.","example":"recurring"},"product_id":{"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Product Id","type":"string"},"proration":{"description":"Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.","example":false,"title":"Proration","type":"boolean"},"proration_details_debit_invoice_item":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"For a credit proration invoice_item, the original debit invoice_item to which the credit proration applies.","example":"invoiceitem_dev_abc234","title":"Proration Details Debit Invoice Item"},"quantity":{"description":"Quantity of the invoice_item.","example":2,"title":"Quantity","type":"integer"},"subscription_cancelled_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Cancellation date of the subscription. It is in 'ISO 8601' format.","title":"Subscription Cancelled At"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the subscription.","example":"subscription_dev_abc123","title":"Subscription Id"},"subscription_item_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing the subscription item for user.","example":"This is the description from the subscription item linked to this invoice item.","title":"Subscription Item Description"},"subscription_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the subscription_item.","example":"subi_dev_abc123","title":"Subscription Item Id"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","name","invoice_id","account_id","amount_atom","currency","customer_id","description","period_end","period_start","price_id","price_type","product_id","proration","quantity","subscription_id","discounts","discount_amount_atoms","amount_atom_considering_discount_applied","proration_details_debit_invoice_item"],"title":"InvoiceItemExternal","type":"object"},"InvoiceItemPublic":{"properties":{"amount_atom":{"description":"Total amount of invoice_item in atomic units (in USD this is cents).","example":200,"title":"Amount Atom","type":"integer"},"amount_atom_considering_discount_applied":{"description":"Total amount of invoice_item in atomic units considering discounts","example":150,"title":"Amount Atom Considering Discount Applied","type":"integer"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"discount_amount_atoms":{"description":"The amount_atom of all discount.","example":[{"amount_atom":50,"discount_id":"discount_dev_123"}],"items":{"$ref":"#/components/schemas/InvoiceItemDiscountAmountsPublic"},"title":"Discount Amount Atoms","type":"array"},"discounts":{"description":"The discounts only directly applied to the InvoiceItem.","example":[],"items":{"type":"string"},"title":"Discounts","type":"array"},"invoice_item_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing the invoice_item for user.","example":"This is the invoice item description.","title":"Invoice Item Description"},"name":{"description":"The name of the line item as it appears in the invoice.","example":"Product A","title":"Name","type":"string"},"period_end":{"description":"End of the usage period of the invoice_item. It is in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","format":"date-time","title":"Period End","type":"string"},"price_tiers":{"description":"The price tiers of the product, if applicable.","example":[{"flat_amount_atom":0,"unit_amount_atom":200,"units_upto":100}],"items":{"$ref":"#/components/schemas/PriceTierPublic"},"title":"Price Tiers","type":"array"},"quantity":{"description":"Quantity of the line item.","example":2,"title":"Quantity","type":"integer"},"subscription_item_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing the subscription item for user.","example":"This is the description from the subscription item linked to this invoice item.","title":"Subscription Item Description"}},"required":["name","quantity","amount_atom","currency","invoice_item_description","discounts","discount_amount_atoms","amount_atom_considering_discount_applied","period_end"],"title":"InvoiceItemPublic","type":"object"},"InvoiceItemsQueryParams":{"properties":{"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coupon id which is applied directly to an invoice item.","title":"Coupon Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the invoice.","example":"invoice_dev_abc123","title":"Invoice Id"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"InvoiceItemsQueryParams","type":"object"},"InvoicePublic":{"properties":{"applied_balance_amount_atom":{"description":"Amount applied from customer balance either from credit or debit. It is in atomic units (in USD this is cents).","example":500,"title":"Applied Balance Amount Atom","type":"integer"},"billed_to":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the customer","example":"John Doe","title":"Billed To"},"billed_to_business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Business name of the customer","example":"Acme LLC","title":"Billed To Business Name"},"billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing address of the customer.","title":"Billing Address"},"branding":{"description":"The branding settings associated with the account","example":{"logo":"https://example.com/logo.png"},"title":"Branding","type":"object"},"card_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CREDIT, DEBIT, or CHARGE CARD","title":"Card Type"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"customer_tax_ids":{"description":"The tax ID settings of the customer.","example":[{"tax_id":"12-3456789","tax_id_type":"us_ein"}],"items":{"$ref":"#/components/schemas/TaxIdSetting"},"title":"Customer Tax Ids","type":"array"},"due_amount_atom":{"description":"Final amount due at this time for this invoice. It isin atomic units (in USD this is cents).","example":8950,"title":"Due Amount Atom","type":"integer"},"due_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Due date to pay the invoice, in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","title":"Due Date"},"id":{"description":"Unique identifier of the invoice.","example":"invoice_dev_abc123","title":"Id","type":"string"},"invoice_pdf_url":{"description":"The URL for the Invoice PDF","title":"Invoice Pdf Url","type":"string"},"is_initial_invoice_for_trial_sub":{"description":"Whether this is the first invoice for a trial subscription.","title":"Is Initial Invoice For Trial Sub","type":"boolean"},"last_four":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last four digits of credit card","title":"Last Four"},"lines":{"description":"List of individual line items that make up the invoice.","items":{"$ref":"#/components/schemas/InvoiceItemPublic"},"title":"Lines","type":"array"},"merchant_tax_ids":{"description":"The tax ID settings of the merchant.","example":[{"is_default":true,"tax_id":"DE123456789","tax_id_type":"eu_vat"}],"items":{"$ref":"#/components/schemas/MerchantTaxIdSetting"},"title":"Merchant Tax Ids","type":"array"},"paid_amount_atom":{"description":"Total amount paid. It is in atomic units (in USD this is cents).","example":9000,"title":"Paid Amount Atom","type":"integer"},"paid_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"When the invoice is paid, in 'ISO 8601' format.","example":"2023-11-04T19:31:08.650160Z","title":"Paid At"},"provider_type_fee_amount_atom":{"description":"Total fee amount charged for the payment provider type in atomic units.","example":900,"title":"Provider Type Fee Amount Atom","type":"integer"},"receipt_pdf_url":{"description":"The URL for the Receipt PDF","title":"Receipt Pdf Url","type":"string"},"remaining_amount_atom":{"description":"Remaining amount of the invoice to be paid. It is in atomic units (in USD this is cents).","example":0,"title":"Remaining Amount Atom","type":"integer"},"status":{"$ref":"#/components/schemas/InvoiceStatusEnum","description":"Status of the invoice.","example":"paid"},"tax_amount_atom":{"description":"Total tax amount in atomic units.","example":900,"title":"Tax Amount Atom","type":"integer"},"total_amount_atom":{"description":"Total amount of the invoice. Sum of invoice_items' total amount. It is in atomic units (in USD this is cents).","example":9000,"title":"Total Amount Atom","type":"integer"},"total_discount_amount_atoms":{"description":"The aggregate amount_atoms calculated per discount across all line items.","example":[{"amount_atom":50,"discount_id":"discount_dev_123"}],"items":{"$ref":"#/components/schemas/InvoiceDiscountAmountsExternal"},"title":"Total Discount Amount Atoms","type":"array"},"total_excluding_taxes_amount_atom":{"description":"Total amount excluding taxes. It is in atomic units (in USD this is cents).","example":8000,"title":"Total Excluding Taxes Amount Atom","type":"integer"},"trial_end_for_sub":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Trial end date for the subscription this invoice is in, if this the initial invoice for the sub.","title":"Trial End For Sub"},"trial_start_for_sub":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Trial start date for the subscription this invoice is in, if this the initial invoice for the sub.","title":"Trial Start For Sub"}},"required":["id","created_at","currency","paid_amount_atom","tax_amount_atom","provider_type_fee_amount_atom","remaining_amount_atom","branding","invoice_pdf_url","receipt_pdf_url","is_initial_invoice_for_trial_sub","trial_start_for_sub","trial_end_for_sub","status","due_amount_atom","applied_balance_amount_atom","total_amount_atom","total_excluding_taxes_amount_atom"],"title":"InvoicePublic","type":"object"},"InvoiceQueryParams":{"properties":{"billing_reason":{"anyOf":[{"$ref":"#/components/schemas/BillingReasonEnum"},{"type":"null"}],"description":"Indicates the reason why the invoice was created.","example":"manual"},"collection_method":{"anyOf":[{"$ref":"#/components/schemas/CollectionMethodEnum"},{"type":"null"}],"description":"Filter by the collection method of the invoice"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coupon id which is applied to an invoice.","title":"Coupon Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Filter by the currency of the invoice"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"period_end":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting invoices based on the range of period ending dates. Includes options for equality, and greater than/less than comparisons.","example":"2023-11-16"},"period_start":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting invoices based on the range of period starting dates. Includes options for equality, and greater than/less than comparisons.","example":"2023-11-13"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Used to search invoices"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"status":{"anyOf":[{"$ref":"#/components/schemas/InvoiceStatusEnum"},{"type":"null"}],"description":"Status of invoice.","example":"draft"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the subscription.","example":"subscription_dev_abc123","title":"Subscription Id"},"total_amount_atom":{"anyOf":[{"$ref":"#/components/schemas/IntRangeFilter"},{"type":"null"}],"description":"This contains fields used for range filters on total_amount_atom field.","example":{"gt":9000}},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"InvoiceQueryParams","type":"object"},"InvoiceSettings":{"properties":{"default_net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Default Net D","title":"Default Net D"}},"title":"InvoiceSettings","type":"object"},"InvoiceStatusEnum":{"enum":["draft","open","void","paid","past_due","uncollectible"],"title":"InvoiceStatusEnum","type":"string"},"InvoiceType":{"enum":["standard","one_off"],"title":"InvoiceType","type":"string"},"ListActiveSubParams":{"properties":{"price_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the price.","example":"price_dev_abc123","title":"Price Id"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of product.","example":"product_dev_abc123","title":"Product Id"}},"title":"ListActiveSubParams","type":"object"},"ListBillingMeterEventSummariesRequest":{"properties":{"customer_id":{"description":"The customer for which to fetch event summaries.","title":"Customer Id","type":"string"},"end_time":{"description":"The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.","format":"date-time","title":"End Time","type":"string"},"meter_id":{"description":"Unique identifier for the meter object.","title":"Meter Id","type":"string"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"start_time":{"description":"The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.","format":"date-time","title":"Start Time","type":"string"},"value_grouping_window":{"anyOf":[{"$ref":"#/components/schemas/MeterEventValueGroupingWindow"},{"type":"null"}],"default":"none","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. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, …, 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC)."}},"required":["customer_id","meter_id","start_time","end_time"],"title":"ListBillingMeterEventSummariesRequest","type":"object"},"ListResponse_BillingMeterExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BillingMeterExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[BillingMeterExternal]","type":"object"},"ListResponse_BillingMeterSummary_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BillingMeterSummary"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[BillingMeterSummary]","type":"object"},"ListResponse_ChargeExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ChargeExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[ChargeExternal]","type":"object"},"ListResponse_CheckoutSessionExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CheckoutSessionExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[CheckoutSessionExternal]","type":"object"},"ListResponse_CouponExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CouponExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[CouponExternal]","type":"object"},"ListResponse_CreditNoteExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CreditNoteExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[CreditNoteExternal]","type":"object"},"ListResponse_CustomerExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomerExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[CustomerExternal]","type":"object"},"ListResponse_EventExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EventExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[EventExternal]","type":"object"},"ListResponse_InvoiceExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[InvoiceExternal]","type":"object"},"ListResponse_InvoiceItemExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceItemExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[InvoiceItemExternal]","type":"object"},"ListResponse_PaymentIntentExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentIntentExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[PaymentIntentExternal]","type":"object"},"ListResponse_PaymentLinkExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentLinkExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[PaymentLinkExternal]","type":"object"},"ListResponse_PaymentRouteExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentRouteExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[PaymentRouteExternal]","type":"object"},"ListResponse_PriceExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PriceExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[PriceExternal]","type":"object"},"ListResponse_ProductExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[ProductExternal]","type":"object"},"ListResponse_ProductFamilyExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductFamilyExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[ProductFamilyExternal]","type":"object"},"ListResponse_PromotionCodeExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PromotionCodeExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[PromotionCodeExternal]","type":"object"},"ListResponse_RefundExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RefundExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[RefundExternal]","type":"object"},"ListResponse_SubscriptionExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[SubscriptionExternal]","type":"object"},"ListResponse_SubscriptionItemExternal_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SubscriptionItemExternal"},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[SubscriptionItemExternal]","type":"object"},"ListResponse_Union_TokenizedCreditCardExternal__PaymentMethodExternal__":{"properties":{"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/TokenizedCreditCardExternal"},{"$ref":"#/components/schemas/PaymentMethodExternal"}]},"title":"Data","type":"array"},"page_number":{"examples":[1],"title":"Page Number","type":"integer"},"page_size":{"examples":[100],"title":"Page Size","type":"integer"},"total_objects":{"examples":[100],"title":"Total Objects","type":"integer"}},"required":["data","total_objects","page_number","page_size"],"title":"ListResponse[Union[TokenizedCreditCardExternal, PaymentMethodExternal]]","type":"object"},"MarkUncollectibleRequest":{"properties":{"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Remarks when marking invoice as uncollectible.","example":"Marked as uncollectible.","title":"Comment"}},"title":"MarkUncollectibleRequest","type":"object"},"MarkVoidRequest":{"properties":{"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Remarks when marking invoice as void.","example":"Marked as void.","title":"Comment"}},"title":"MarkVoidRequest","type":"object"},"MerchantTaxIdSetting":{"properties":{"is_default":{"description":"Whether this tax ID is the default for the country","title":"Is Default","type":"boolean"},"tax_id":{"description":"The tax ID value","title":"Tax Id","type":"string"},"tax_id_type":{"description":"The type code for this tax ID","title":"Tax Id Type","type":"string"}},"required":["tax_id_type","tax_id","is_default"],"title":"MerchantTaxIdSetting","type":"object"},"MeterEventValueGroupingWindow":{"enum":["day","hour","none"],"title":"MeterEventValueGroupingWindow","type":"string"},"NonPciIntegration":{"properties":{"account_id":{"description":"The account ID","examples":["acct_xxxxxxxxxxxxxxxxx"],"title":"Account Id","type":"string"},"configuration":{"description":"The configuration fields","items":{"anyOf":[{"$ref":"#/components/schemas/StringConfigField"},{"$ref":"#/components/schemas/NumberConfigField"},{"$ref":"#/components/schemas/BooleanConfigField"},{"$ref":"#/components/schemas/EnumConfigField"}]},"title":"Configuration","type":"array"},"integration_id":{"description":"The integration ID","examples":["intg_xxxxxxxxxxxxxxxxx"],"title":"Integration Id","type":"string"},"integration_type":{"$ref":"#/components/schemas/NonPciIntegrationEnum","description":"The integration type","examples":["chartmogul"]}},"required":["account_id","integration_id","integration_type"],"title":"NonPciIntegration","type":"object"},"NonPciIntegrationEnum":{"enum":["chartmogul","intercom"],"title":"NonPciIntegrationEnum","type":"string"},"NumberConfigField":{"properties":{"default_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The default value of the number.","title":"Default Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The description of the field.","title":"Description"},"key":{"description":"The key of the field in the config.","title":"Key","type":"string"},"max_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The maximum value of the number.","title":"Max Value"},"min_value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum value of the number.","title":"Min Value"},"name":{"description":"The name of the field.","title":"Name","type":"string"},"type":{"const":"number","default":"number","title":"Type","type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The value of the field.","title":"Value"}},"required":["name","key","value"],"title":"NumberConfigField","type":"object"},"ObjectName":{"enum":["account","api_token","billing_meter","billing_meter_event","billing_meter_event_adjustment","charge","checkout_attempt","checkout_session","checkout_session_item","coupon","credit_note","credit_note_item","customer","customer_balance_transaction","delivery_attempt","discount","dispute","event","invite","invoice_item_discount","invoice","invoice_discount","invoice_item","payment_intent","payment_link","payment_link_line_item","payment_method","tokenized_card_payment_method","payment_method_mapping","payment_processor","payment_route","portal_session","price","price_tier","product","product_family","promotion_code","refund","setup_intent","signup_answers","signup_questions","signup_questionnaire_status","single_use_token","subscription","subscription_item","tax_integration","user","user_login","user_record","user_record_summary","transition_eligibility","webhook_endpoint","email","analytics_segment"],"title":"ObjectName","type":"string"},"PayInvoiceRequest":{"properties":{"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Remarks when marking invoice as paid.","example":"Marked as paid.","title":"Comment"},"paid_out_of_band":{"default":false,"description":"Boolean representing whether an invoice is paid outside of OpenPay. This will result in no charge being made. Defaults to false.","title":"Paid Out Of Band","type":"boolean"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the payment method.","example":"pm_dev_abc123","title":"Payment Method Id"},"void_on_failure":{"default":false,"description":"Void the invoice if payment fails.","title":"Void On Failure","type":"boolean"}},"title":"PayInvoiceRequest","type":"object"},"PaymentIntentExternal":{"properties":{"amount_atom":{"title":"Amount Atom","type":"integer"},"amount_atom_capturable":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Atom Capturable"},"amount_atom_received":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Atom Received"},"charge_ids":{"items":{"type":"string"},"title":"Charge Ids","type":"array"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the payment intent. This can be useful to store the additional data related to the payment intent.","title":"Custom Fields"},"customer_id":{"title":"Customer Id","type":"string"},"decline_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Decline Reason"},"id":{"title":"Id","type":"string"},"invoice":{"anyOf":[{"$ref":"#/components/schemas/InvoiceExternal"},{"type":"null"}]},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"invoice_payment_provider_type_fee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Payment Provider Type Fee"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"last_refund_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Last Refund Date"},"object":{"$ref":"#/components/schemas/ObjectName","default":"payment_intent"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Id"},"payment_processor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Processor Name"},"refund_ids":{"items":{"type":"string"},"title":"Refund Ids","type":"array"},"status":{"$ref":"#/components/schemas/PaymentIntentStatus"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_atom","amount_atom_capturable","amount_atom_received","currency","customer_id","payment_method_id","status","invoice_id","invoice_payment_provider_type_fee","charge_ids","refund_ids","invoice","last_refund_date","decline_reason","payment_processor_name"],"title":"PaymentIntentExternal","type":"object"},"PaymentIntentQueryParams":{"properties":{"amount_atom":{"anyOf":[{"$ref":"#/components/schemas/IntRangeFilter"},{"type":"null"}],"description":"This contains fields used for range filters on amount_atom field."},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only return PaymentIntents for the customer that this customer ID specifies.","examples":["cus_dev_abc123"],"title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the invoice that created the PaymentIntent.","title":"Invoice Id"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the payment method associated with the PaymentIntent.","title":"Payment Method Id"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Used to search payment intents"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"status":{"anyOf":[{"$ref":"#/components/schemas/PaymentIntentStatus"},{"type":"null"}],"description":"Status of the PaymentIntent."},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"PaymentIntentQueryParams","type":"object"},"PaymentIntentStatus":{"enum":["requires_confirmation","requires_capture","requires_action","requires_payment_method","processing","canceled","succeeded","exception"],"title":"PaymentIntentStatus","type":"string"},"PaymentLinkExternal":{"properties":{"account_id":{"description":"Unique Identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"account_name":{"description":"Name of the account.","example":"foobar","title":"Account Name","type":"string"},"active":{"description":"Whether a payment link is active or not.","example":true,"title":"Active","type":"boolean"},"checkout_preferences":{"anyOf":[{"$ref":"#/components/schemas/CheckoutPreferencesOutput"},{"type":"null"}],"description":"The checkout preferences to pass to checkout session creation."},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this payment link.","example":"coupon_dev_abc123","title":"Coupon Id"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Currency code, e.g., USD.","example":"usd","title":"Currency"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs attached to the payment link.","title":"Custom Fields"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer's email.","example":"foobar@gmail.com","title":"Customer Email"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"id":{"description":"Unique Identifier of the checkout session.","example":"plink_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"line_items":{"description":"The line items purchased by the customers.","example":[{"id":"li_dev_abc123","payment_link_id":"plink_dev_abc123","price_id":"price_dev_abc123","quantity":3}],"items":{"$ref":"#/components/schemas/PaymentLinkLineItemExternal"},"title":"Line Items","type":"array"},"mode":{"$ref":"#/components/schemas/CheckoutMode","description":"The mode of the checkout sessions created by this payment link.","example":"payment"},"object":{"$ref":"#/components/schemas/ObjectName","default":"payment_link"},"secure_token":{"description":"The random secure token associated with the payment link.","example":"33544253-7d23-4e58-9d58-860977eb36d3","title":"Secure Token","type":"string"},"success_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The success URL for the checkout sessions created by this payment link.","example":"http://example.com","title":"Success Url"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Then trial_end param for the checkout sessions created by this payment link.","title":"Trial End"},"trial_from_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Then trial_from_price param for the checkout sessions created by this payment link.","title":"Trial From Price"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Then trial_period_days param for the checkout sessions created by this payment link.","title":"Trial Period Days"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"},"url":{"description":"The main URL for this payment link.","example":"https://connto.getopenpay.com/payment-link/public/aaaa-bbbb-cccc-dddd","title":"Url","type":"string"}},"required":["id","created_at","updated_at","account_id","account_name","active","currency","customer_id","customer_email","line_items","mode","secure_token","success_url","trial_end","trial_period_days","trial_from_price","url","checkout_preferences"],"title":"PaymentLinkExternal","type":"object"},"PaymentLinkLineItemExternal":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique identifier of the payment link line item.","example":"li_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"payment_link_line_item"},"payment_link_id":{"description":"The ID of the payment link associated with this item","example":"plink_dev_abc123","title":"Payment Link Id","type":"string"},"price_id":{"description":"Unique identifier of the price.","example":"price_dev_abc123","title":"Price Id","type":"string"},"quantity":{"description":"Quantity of the item.","example":2,"title":"Quantity","type":"integer"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","payment_link_id","price_id","quantity"],"title":"PaymentLinkLineItemExternal","type":"object"},"PaymentLinkQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"PaymentLinkQueryParams","type":"object"},"PaymentMethodExternal":{"properties":{"billing_address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"The card's billing address.","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"card_brand":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. VISA, AMERICAN_EXPRESS, EBT, DISCOVER","example":"VISA","title":"Card Brand"},"card_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CREDIT, DEBIT, CHARGE CARD","example":"CREDIT","title":"Card Type"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the Customer to which this PaymentMethod is attached.","examples":["cus_dev_123"],"title":"Customer Id"},"display_name":{"description":"Display name for the payment method to show on the UI.","title":"Display Name","type":"string"},"id":{"description":"Unique Identifier of the payment_method.","example":"pm_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"last_four":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last four digits of this card","example":"8726","title":"Last Four"},"mappings":{"default":[],"description":"List of payment method mappings associated with this payment method. Include \"mappings\" in the expand parameter to retrieve this data.","items":{"$ref":"#/components/schemas/PaymentMethodMappingExternal"},"title":"Mappings","type":"array"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"object":{"$ref":"#/components/schemas/ObjectName","default":"payment_method"},"provider":{"$ref":"#/components/schemas/PaymentProviderType","description":"The provider type for this payment method","example":"credit_card"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","provider","display_name"],"title":"PaymentMethodExternal","type":"object"},"PaymentMethodMappingExternal":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique identifier of the payment method mapping.","example":123,"title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"charge"},"payment_method_id":{"description":"External id for payment method","example":"pm_1Hg3x2IyNTgGDVfzQ9oJlvT2","title":"Payment Method Id","type":"string"},"processor_id":{"description":"External id for processor","example":"processor_j48zajalregth7","title":"Processor Id","type":"string"},"processor_name":{"$ref":"#/components/schemas/PaymentProcessorName","description":"Name of the payment processor.","example":"Stripe"},"their_payment_method_id":{"description":"The payment method identifier from the processor's perspective.","example":"stripepm_1Hg3x2IyNTgGDVfzQ9oJlvT2","title":"Their Payment Method Id","type":"string"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","processor_name","processor_id","payment_method_id","their_payment_method_id"],"title":"PaymentMethodMappingExternal","type":"object"},"PaymentProcessorName":{"description":"PaymentProcessors are api's that we support and can charge.","enum":["adyen","airwallex","authorize_net","checkout_com","braintree","stripe","foobar","pockyt","cybersource","loop"],"title":"PaymentProcessorName","type":"string"},"PaymentProviderType":{"description":"Not to be confused with PaymentProcessor, this type is used in PaymentMethod\nwhich are methods that are visible to customer (i.e. customer has an option to\npay with these different providers).","enum":["_abstract_base","ach","apple_pay","credit_card","google_pay","stripe_link","paypal","crypto"],"title":"PaymentProviderType","type":"string"},"PaymentRouteExternal":{"properties":{"account_id":{"description":"Unique Identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique Identifier of the payment route.","example":"proute_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"name":{"description":"The name of the payment route.","example":"My Payment Route","title":"Name","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"payment_route"},"route_config":{"description":"The configuration object for the payment route.","title":"Route Config","type":"object"},"route_type":{"$ref":"#/components/schemas/PaymentRouteType","description":"The type of payment route."},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","account_id","name","route_type","route_config"],"title":"PaymentRouteExternal","type":"object"},"PaymentRouteType":{"enum":["deprecated","simple_mit_cit_filter","cit_mit_processors"],"title":"PaymentRouteType","type":"string"},"PortalSessionExternal":{"properties":{"account_id":{"description":"Unique identifier for the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_id":{"description":"The ID of an existing customer.","example":"cust_dev_abc123","title":"Customer Id","type":"string"},"id":{"description":"The ID of the portal session.","example":"bps_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"portal_session"},"return_url":{"description":"The default URL to redirect customers to when they click on the portal\"s link to return to your website.","example":"http://example.com/account","title":"Return Url","type":"string"},"token":{"description":"The short-lived token of the session that gives customers access to the customer portal.","example":"00000000-aaaa-bbbb-cccc-dddddddddddd","title":"Token","type":"string"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"},"url":{"description":"The short-lived URL of the session that gives customers access to the customer portal.","example":"http://getopenpay.com/billing-portal/#00000000-aaaa-bbbb-cccc-dddddddddddd","title":"Url","type":"string"}},"required":["id","created_at","updated_at","account_id","customer_id","return_url","url","token"],"title":"PortalSessionExternal","type":"object"},"PriceExternal":{"properties":{"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/CalendarIntervalEnum"},{"type":"null"}],"description":"The interval unit for billing within the contract term. For recurring payments, this indicates how often each billing cycle occurs. For one-time payments, it dictates how the total amount is divided and billed over time.","example":"month"},"billing_interval_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of interval units that make up one complete billing cycle. For example, \"MONTH\" and a count of \"3\" means billing happens every 3 months.","example":3,"title":"Billing Interval Count"},"billing_scheme":{"$ref":"#/components/schemas/BillingSchemeEnum","description":"Describes how to compute the price per period.","example":"tiered"},"can_only_be_purchased_with":{"description":"This price can only be purchased in a subscription if subscriptioncontains at least one of these prices.","example":["price_dev_35agti"],"items":{"type":"string"},"title":"Can Only Be Purchased With","type":"array"},"contract_auto_renew":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not the contract auto-renews at the end of its term.","example":true,"title":"Contract Auto Renew"},"contract_term_multiple":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Defines a multiple on top of billing_interval, billing_interval_count for which this price should be under contract for.","example":2,"title":"Contract Term Multiple"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase."},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs attached to the price.","title":"Custom Fields"},"eligible_for_updates":{"description":"If the price can be updated or not.","title":"Eligible For Updates","type":"boolean"},"id":{"description":"Unique identifier of the price.","example":"price_dev_abc123","title":"Id","type":"string"},"internal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing this price.","example":"Description for the price.","title":"Internal Description"},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/InvoiceSettings"},{"type":"null"}],"description":"Default Net D","example":{"default_net_d":2}},"is_active":{"description":"Whether the price can be used for new purchases. Price can be activated later.","example":true,"title":"Is Active","type":"boolean"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this price is the default price for the product.","example":false,"title":"Is Default"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"is_exclusive":{"default":false,"description":"Whether the price is exclusive or not.","example":false,"title":"Is Exclusive","type":"boolean"},"is_licensed":{"description":"Whether the price is licensed or not.","example":true,"title":"Is Licensed","type":"boolean"},"listed_exclusively_for_customers":{"description":"If is_exclusive, this is the list of customers who can see the price.","example":["cus_dev_abc123"],"items":{"type":"string"},"title":"Listed Exclusively For Customers","type":"array"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"meter_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of meter tracking the usage of a metered price.","title":"Meter Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the price.","title":"Name"},"object":{"$ref":"#/components/schemas/ObjectName","default":"price"},"optional_add_ons":{"description":"Add-ons that can be optionally purchased with this price.","example":["price_dev_ka8i4"],"items":{"type":"string"},"title":"Optional Add Ons","type":"array"},"price_tiers":{"description":"List of price_tiers.","example":[{"flat_amount_atom":0,"unit_amount_atom":100,"units_upto":10},{"unit_amount_atom":90}],"items":{"$ref":"#/components/schemas/PriceTierExternal"},"title":"Price Tiers","type":"array"},"price_type":{"$ref":"#/components/schemas/PriceTypeEnum","description":"One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.","example":"recurring"},"product":{"anyOf":[{"$ref":"#/components/schemas/ProductExternal"},{"type":"null"}],"description":"Details of the product."},"product_id":{"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Product Id","type":"string"},"product_name":{"description":"Name of the product associated with this price.","example":"Product Name","title":"Product Name","type":"string"},"recurring_details":{"anyOf":[{"$ref":"#/components/schemas/RecurringDetails"},{"type":"null"}],"description":"Object containing recurring components of a price such as 'interval' and 'usage_type'.","example":{"usage_type":"licensed"}},"tiers_mode":{"anyOf":[{"$ref":"#/components/schemas/PricingTiersEnum"},{"type":"null"}],"description":"Defines if the tiering price should be 'graduated' or 'volume' based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.","example":"graduated"},"transform_quantity_divide_by":{"description":"This transformation will be applied on quantity before mulitplying by 'unit_amount_atom'.","example":1,"title":"Transform Quantity Divide By","type":"number"},"unit_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The unit amount in atom to be charged.It is in atomic units (in USD this is cents).","example":100,"title":"Unit Amount Atom"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","is_active","product_name","product_id","internal_description","billing_scheme","unit_amount_atom","transform_quantity_divide_by","price_tiers","price_type","recurring_details","tiers_mode","billing_interval","billing_interval_count","contract_term_multiple","contract_auto_renew","invoice_settings","is_licensed","listed_exclusively_for_customers","can_only_be_purchased_with","optional_add_ons","eligible_for_updates","currency","is_default"],"title":"PriceExternal","type":"object"},"PriceQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Currency in which the price is.","example":"usd"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether price is active or not.","example":true,"title":"Is Active"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"price_type":{"anyOf":[{"$ref":"#/components/schemas/PriceTypeEnum"},{"type":"null"}],"description":"Type of price.","example":"recurring"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Product Id"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"PriceQueryParams","type":"object"},"PriceTierExternal":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"flat_amount_atom":{"title":"Flat Amount Atom","type":"integer"},"id":{"description":"Unique identifier for the object.","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"price_tier"},"unit_amount_atom":{"title":"Unit Amount Atom","type":"integer"},"units_upto":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Units Upto"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","unit_amount_atom","flat_amount_atom"],"title":"PriceTierExternal","type":"object"},"PriceTierParams":{"properties":{"flat_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"description":"Flat fee for the tier the smallest denomination.It is in atomic units (in USD this is cents).","example":0,"title":"Flat Amount Atom"},"unit_amount_atom":{"description":"The price for the unit in the smallest denomination.It is in atomic units (in USD this is cents).","example":100,"title":"Unit Amount Atom","type":"integer"},"units_from":{"description":"The starting unit for the price tier.","example":1,"title":"Units From","type":"integer"},"units_upto":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The ending unit for the price tier. The last tier in the list should not have this key or null, indicating that the tier extends to an infinite number of units.","example":10,"title":"Units Upto"}},"required":["units_from","unit_amount_atom"],"title":"PriceTierParams","type":"object"},"PriceTierPublic":{"properties":{"flat_amount_atom":{"description":"Flat price in the currency atom.","example":1000,"title":"Flat Amount Atom","type":"integer"},"unit_amount_atom":{"description":"Price per unit in the currency atom.","example":1000,"title":"Unit Amount Atom","type":"integer"},"units_upto":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum quantity of units that can be purchased at this price tier","example":100,"title":"Units Upto"}},"required":["unit_amount_atom","flat_amount_atom"],"title":"PriceTierPublic","type":"object"},"PriceTypeEnum":{"enum":["one_time","recurring"],"title":"PriceTypeEnum","type":"string"},"PricingModel":{"enum":["standard","package","graduated","volume"],"title":"PricingModel","type":"string"},"PricingTiersEnum":{"enum":["graduated","volume"],"title":"PricingTiersEnum","type":"string"},"ProductExternal":{"properties":{"account_sku":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SKU for given product. eg. Barcode numbers of inventory item.","example":"abc123","title":"Account Sku"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the product. This can be useful to store the additional data related to the product.","title":"Custom Fields"},"default_price":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the default price.","examples":["123"],"title":"Default Price"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Product's description.","example":"This is description for product1","title":"Description"},"features":{"description":"List of product features.","example":["feature1 of product1","feature2 of product1"],"items":{"type":"string"},"title":"Features","type":"array"},"id":{"description":"Unique identifier of the product.","example":"product_dev_abc123","title":"Id","type":"string"},"is_active":{"description":"Whether the product is currently available for purchase.","example":true,"title":"Is Active","type":"boolean"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"name":{"description":"Name of product.","example":"product1","title":"Name","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"product"},"prices":{"items":{"$ref":"#/components/schemas/PriceExternal"},"title":"Prices","type":"array"},"unit_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unit label","title":"Unit Label"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","name","description","features","default_price","is_active","prices","account_sku","unit_label"],"title":"ProductExternal","type":"object"},"ProductFamilyExternal":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description of the product family.","example":"This is a description for Product Family 1.","title":"Description"},"hierarchy":{"default":"{}","description":"A JSON object representing the hierarchy within the family.","example":"{\"product_abc13\": 1, \"product_abd48\": 2}","title":"Hierarchy","type":"string"},"id":{"description":"Unique identifier of the product family.","example":"family_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"name":{"description":"Name of the product family.","example":"Product Family 1","title":"Name","type":"string"},"object":{"$ref":"#/components/schemas/ObjectName","default":"product_family"},"products":{"description":"List of products in the family","example":["product_abc13","product_abd48"],"items":{"type":"string"},"title":"Products","type":"array"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","name","description","products"],"title":"ProductFamilyExternal","type":"object"},"ProductFamilyQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"is_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"Filter product families by is_deleted","title":"Is Deleted"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"ProductFamilyQueryParams","type":"object"},"ProductQueryParams":{"properties":{"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of user who created the product.","title":"Created By"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether product is active or not.","title":"Is Active"},"name_contains":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"List only products containing this string (case-insensitive).","title":"Name Contains"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Search for products based on provided name, percent_off, amount_atom_off"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"ProductQueryParams","type":"object"},"PromoCodeQueryParams":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only return promotion codes for this coupon.","title":"Coupon Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"expires_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter by the date the promotion code expires"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Search for promotion codes based on provided code"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"PromoCodeQueryParams","type":"object"},"PromoRestrictions":{"properties":{"first_time_transaction":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.","title":"First Time Transaction"},"minimum_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).","title":"Minimum Amount Atom"},"minimum_amount_currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Three-letter ISO code for minimum_amount"}},"title":"PromoRestrictions","type":"object"},"PromotionCodeExternal":{"properties":{"code":{"title":"Code","type":"string"},"coupon":{"$ref":"#/components/schemas/CouponExternal","description":"Coupon object for this promotion code."},"coupon_id":{"title":"Coupon Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_ids":{"description":"List of customer ids who can redeem this PromotionCode. If empty all customers can redeem it.","items":{"type":"string"},"title":"Customer Ids","type":"array"},"expires_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"title":"Expires At"},"id":{"title":"Id","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"max_redemptions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Redemptions"},"max_redemptions_per_customer":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Redemptions Per Customer"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"object":{"$ref":"#/components/schemas/ObjectName","default":"promotion_code"},"restrictions":{"anyOf":[{"$ref":"#/components/schemas/PromoRestrictions"},{"type":"null"}]},"times_redeemed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Times Redeemed"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","code","is_active","coupon_id","coupon","restrictions"],"title":"PromotionCodeExternal","type":"object"},"ProrationEnum":{"enum":["create_prorations","none","always_invoice"],"title":"ProrationEnum","type":"string"},"RecurringDetails":{"properties":{"aggregate_usage":{"anyOf":[{"$ref":"#/components/schemas/UsageAggMethodEnum"},{"type":"null"}]},"trial_period_days":{"default":0,"title":"Trial Period Days","type":"integer"},"usage_type":{"$ref":"#/components/schemas/UsageTypeEnum"}},"required":["usage_type"],"title":"RecurringDetails","type":"object"},"RefundExternal":{"properties":{"amount_atom":{"description":"amount_atom that you want to refund.","example":7000,"title":"Amount Atom","type":"integer"},"attempt_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Error text if refund attempt was failed.","title":"Attempt Error Message"},"charge_id":{"description":"Unique Identifier of the charge.","example":"charge_dev_abc123","title":"Charge Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","default":"usd","description":"Three-letter ISO currency code, in lowercase."},"id":{"description":"Unique Identifier of the refund.","example":"refund_dev_abc123","title":"Id","type":"string"},"invoice_id":{"description":"Invoice id to which the refund is attached.","example":"invoice_dev_abc123","title":"Invoice Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"refund"},"payment_intent_id":{"description":"Unique Identifier of the payment_intent.","example":"pi_dev_abc123","title":"Payment Intent Id","type":"string"},"reason":{"$ref":"#/components/schemas/RefundReasonEnum","description":"Reason of the refund.","example":"manual"},"status":{"$ref":"#/components/schemas/RefundStatusEnum","description":"Status of the refund.","example":"succeeded"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","amount_atom","charge_id","invoice_id","payment_intent_id","reason","status"],"title":"RefundExternal","type":"object"},"RefundQueryParams":{"properties":{"amount_atom":{"anyOf":[{"$ref":"#/components/schemas/IntRangeFilter"},{"type":"null"}],"description":"This contains fields used for range filters on amount_atom field."},"charge_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the charge.","title":"Charge Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the customer.","title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"payment_intent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the payment_intent.","title":"Payment Intent Id"},"reason":{"anyOf":[{"$ref":"#/components/schemas/RefundReasonEnum"},{"type":"null"}],"description":"Reason of the refund."},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"status":{"anyOf":[{"$ref":"#/components/schemas/RefundStatusEnum"},{"type":"null"}],"description":"Status of the refund."},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"RefundQueryParams","type":"object"},"RefundReasonEnum":{"enum":["manual","duplicate","fraudulent","requested_by_customer","expired_uncaptured_charge","manual_out_of_band"],"title":"RefundReasonEnum","type":"string"},"RefundStatusEnum":{"enum":["succeeded","failed","pending","requires_action","canceled"],"title":"RefundStatusEnum","type":"string"},"ResumeSubscriptionResponse":{"properties":{"invoice":{"anyOf":[{"$ref":"#/components/schemas/InvoiceExternal"},{"type":"null"}],"description":"The invoice created for any floating charges including the proration charges"},"subscription":{"$ref":"#/components/schemas/SubscriptionExternal","description":"The subscription being resumed."}},"required":["subscription"],"title":"ResumeSubscriptionResponse","type":"object"},"SearchFilter":{"description":"Represents a string filter with various comparison options.\n\nAttributes (Only one of these should be populated or else....):\n- ilike (Optional[str]): Field values should be ilike to this value.","properties":{"eq":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter values equal to this value.","title":"Eq"},"ilike":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter values like this value.","title":"Ilike"}},"title":"SearchFilter","type":"object"},"SelectedPriceQuantity":{"properties":{"price_id":{"description":"Unique Identifier of the price.","title":"Price Id","type":"string"},"quantity":{"description":"Quantity of the product selected for the subscription.This field is ignored for metered prices","title":"Quantity","type":"integer"}},"required":["price_id","quantity"],"title":"SelectedPriceQuantity","type":"object"},"SetupIntentExternal":{"properties":{"account_id":{"description":"Unique Identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"id":{"description":"Unique Identifier of the setup intent.","example":"si_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"setup_intent"},"payment_method_ids":{"description":"Payment methods created from this setup intent.","example":["pm_dev_abc123"],"items":{"type":"string"},"title":"Payment Method Ids","type":"array"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","account_id","customer_id","payment_method_ids"],"title":"SetupIntentExternal","type":"object"},"SignupQuestionnaireStatus":{"properties":{"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique identifier for the object.","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"signup_questionnaire_status"},"status":{"description":"The status of the questionnaire.","example":true,"title":"Status","type":"boolean"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","status"],"title":"SignupQuestionnaireStatus","type":"object"},"StringConfigField":{"properties":{"default_value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The default value of the string.","title":"Default Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The description of the field.","title":"Description"},"key":{"description":"The key of the field in the config.","title":"Key","type":"string"},"max_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The maximum length of the string.","title":"Max Length"},"min_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The minimum length of the string.","title":"Min Length"},"name":{"description":"The name of the field.","title":"Name","type":"string"},"type":{"const":"string","default":"string","title":"Type","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value of the field.","title":"Value"}},"required":["name","key","value"],"title":"StringConfigField","type":"object"},"SubscriptionCancelFeedbackEnum":{"enum":["too_expensive","missing_features","switched_service","unused","customer_service","too_complex","low_quality","other"],"title":"SubscriptionCancelFeedbackEnum","type":"string"},"SubscriptionCancellationDetails":{"properties":{"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Any comment regarding subscription.","title":"Comment"},"feedback":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionCancelFeedbackEnum"},{"type":"null"}],"description":"Feedback of the subscription."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reason why the subscription is canceled.","title":"Reason"}},"title":"SubscriptionCancellationDetails","type":"object"},"SubscriptionExternal":{"properties":{"account_id":{"description":"Unique Identifier of the account.","example":"account_dev_abc123","title":"Account Id","type":"string"},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/CalendarIntervalEnum"},{"type":"null"}],"description":"billing interval for recurring subscriptions."},"billing_interval_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"billing interval count for recurring subscriptions.","title":"Billing Interval Count"},"cancel_at_end":{"description":"Whether this subscription should cancel at the end of contract or billing cycle.","example":true,"title":"Cancel At End","type":"boolean"},"cancellation_details":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionCancellationDetails"},{"type":"null"}],"description":"Cancellation detail of the subscription if canceled.","example":{"comment":"Comment for the subscription.","feedback":"unused","reason":"Canceled at period end."}},"cancelled_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"DateTime at which the subscription was cancelled, in 'ISO 8601' format.","title":"Cancelled At"},"checkout_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the checkout session which created the subscription.","title":"Checkout Session Id"},"collection_method":{"$ref":"#/components/schemas/CollectionMethodEnum","description":"Invoices that are generated from this subscription have this collection method.","example":"charge_automatically"},"contract_auto_renew":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not the contract auto-renews at the end of its term.","example":true,"title":"Contract Auto Renew"},"contract_start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Start date of the subscription contract.","example":"2023-10-02T08:49:54.678156Z","title":"Contract Start"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"current_period_end":{"description":"End of the current billing period, in 'ISO 8601' format.","example":"2023-11-02T08:49:54.678156Z","format":"date-time","title":"Current Period End","type":"string"},"current_period_start":{"description":"Starting of the current billing period, in 'ISO 8601' format.","example":"2023-10-02T08:49:54.678156Z","format":"date-time","title":"Current Period Start","type":"string"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the subscription. This can be useful to store the additional data related to the subscription.","title":"Custom Fields"},"customer_id":{"description":"Unique Identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id","type":"string"},"default_payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the payment_method.","example":"cc_dev_abc123","title":"Default Payment Method Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary String describing the subscription.","example":"Description of this subscription.","title":"Description"},"discount":{"anyOf":[{"$ref":"#/components/schemas/DiscountExternal"},{"type":"null"}],"description":"Discount applied to the subscription."},"id":{"description":"Unique Identifier of the subscription.","example":"subscription_dev_abc123","title":"Id","type":"string"},"initial_start":{"description":"Very beginning of the subscription, in 'ISO 8601' format.","example":"2023-10-02T08:49:54.678156Z","format":"date-time","title":"Initial Start","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"name":{"description":"Name for this subscription.","title":"Name","type":"string"},"net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Net-d set manually for this subscrpition. If unset net-d from Price will apply.","example":-1,"title":"Net D"},"object":{"$ref":"#/components/schemas/ObjectName","default":"subscription"},"pause_at_end":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether this subscription should pause at the end of contract or billing cycle.","title":"Pause At End"},"pause_for_cycles":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Fow how may billing cycles this subscription should be paused.","title":"Pause For Cycles"},"paused_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Datetime at which subscription was paused.","title":"Paused At"},"remaining_billing_cycles":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of billing cycles remaining in contract.","example":12,"title":"Remaining Billing Cycles"},"renews_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"The datetime of the next renewal.","title":"Renews At"},"resumes_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Datetime at which subscription will resume.","title":"Resumes At"},"status":{"$ref":"#/components/schemas/SubscriptionStatusEnum","description":"Current status of the subscription.","example":"canceled"},"subscription_items":{"description":"List of subscription items.","example":[{"deleted":false,"id":"subi_dev_abc123","price_id":"price_dev_abc123","quantity":2,"subscription_id":"subscription_dev_abc123"}],"items":{"$ref":"#/components/schemas/SubscriptionItemExternal"},"title":"Subscription Items","type":"array"},"total_billing_cycles":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Total billing cycles in the contract.","example":12,"title":"Total Billing Cycles"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"End date of the trial","title":"Trial End"},"trial_start":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Start date of the trial","title":"Trial Start"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","name","account_id","customer_id","description","status","initial_start","current_period_start","current_period_end","default_payment_method_id","cancel_at_end","currency","subscription_items","cancelled_at","collection_method","net_d"],"title":"SubscriptionExternal","type":"object"},"SubscriptionItemDetails":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"title":"SubscriptionItemDetails","type":"object"},"SubscriptionItemExternal":{"properties":{"add_at_period_end":{"description":"Whether or not this item will be added before next renewal","example":true,"title":"Add At Period End","type":"boolean"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"currency":{"$ref":"#/components/schemas/CurrencyEnum","description":"Three-letter ISO currency code, in lowercase.","example":"usd"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with the subscription item. This can be useful to store the additional data related to the subscription item.","title":"Custom Fields"},"deleted_at":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"If deleted, then this is the 'ISO 8601' it was deleted","example":false,"title":"Deleted At"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary String describing the subscription item.","example":"Description of this subscription item.","title":"Description"},"drop_at_end":{"description":"Whether or not this item will be dropped from subscription before next renewal","example":false,"title":"Drop At End","type":"boolean"},"id":{"description":"Unique Identifier of the subscription_item.","example":"subi_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"subscription_item"},"pending_attachment_to_subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the subscription in which this itemwill be included upon renewal.","title":"Pending Attachment To Subscription Id"},"price":{"$ref":"#/components/schemas/PriceExternal","description":"Price object associated with subscription_item"},"price_id":{"description":"Unique Identifier of the price.","example":"price_dev_abc123","title":"Price Id","type":"string"},"product_id":{"description":"Unique Identifier of the product.","example":"product_dev_xyz123","title":"Product Id","type":"string"},"quantity":{"description":"Quantity of the product selected for the subscription_item.","example":2,"title":"Quantity","type":"integer"},"subscription_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the subscription.","example":"subscription_dev_abc123","title":"Subscription Id"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","price_id","price","product_id","currency","quantity","deleted_at","drop_at_end","add_at_period_end"],"title":"SubscriptionItemExternal","type":"object"},"SubscriptionItemQueryParams":{"properties":{"subscription_id":{"description":"The ID of the subscription whose items will be retrieved.","example":"subi_dev_abc123","title":"Subscription Id","type":"string"}},"required":["subscription_id"],"title":"SubscriptionItemQueryParams","type":"object"},"SubscriptionPauseRequest":{"properties":{"is_preview":{"default":false,"description":"Whether the request is in preview mode (Subscription won't actually pause)","examples":[false],"title":"Is Preview","type":"boolean"},"number_of_billing_cycles_to_skip":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of billing cycles this subscription will be paused. Passing 0 will clear the scheduled pause irrespective of how it was set.","title":"Number Of Billing Cycles To Skip"},"resumption_date":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Indicates when the subscription will resume.","title":"Resumption Date"}},"title":"SubscriptionPauseRequest","type":"object"},"SubscriptionQueryParams":{"properties":{"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Coupon id which is applied to a subscription.","title":"Coupon Id"},"created_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of creation dates. Includes options for equality, and greater than/less than comparisons."},"current_period_end":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting subscriptions based on the range of current period ending dates. Includes options for equality, and greater than/less than comparisons.","example":{"eq":"2023-11-16T09:48:40.852054Z"}},"current_period_start":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting subscriptions based on the range of current period starting dates. Includes options for equality, and greater than/less than comparisons.","example":{"eq":"2023-11-16T09:48:40.852054Z"}},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the customer.","example":"cus_dev_abc123","title":"Customer Id"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"type":"string"},"title":"Expand","type":"array"},"page_number":{"default":1,"description":"Page number","minimum":1,"title":"Page Number","type":"integer"},"page_size":{"default":100,"description":"Page size","maximum":100,"minimum":1,"title":"Page Size","type":"integer"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique Identifier of the price.","example":"price_dev_abc123","title":"Price Id"},"product_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of product.","example":"product_dev_abc123","title":"Product Id"},"search":{"anyOf":[{"$ref":"#/components/schemas/SearchFilter"},{"type":"null"}],"description":"Used to search subscriptions"},"sort_descending":{"default":false,"description":"Sort direction.","title":"Sort Descending","type":"boolean"},"sort_key":{"default":"created_at","description":"Key name based on which data is sorted.","title":"Sort Key","type":"string"},"statuses":{"default":[],"description":"Current statuses of the subscription.","example":["canceled","active"],"items":{"$ref":"#/components/schemas/SubscriptionStatusEnum"},"title":"Statuses","type":"array"},"updated_at":{"anyOf":[{"$ref":"#/components/schemas/DateTimeFilter"},{"type":"null"}],"description":"Filter for selecting objects based on the range of updated dates. Includes options for equality, and greater than/less than comparisons."}},"title":"SubscriptionQueryParams","type":"object"},"SubscriptionResumeRequest":{"properties":{"is_preview":{"default":false,"description":"Whether the request is in preview mode (subscriptions won't actually be resumed)","example":false,"title":"Is Preview","type":"boolean"},"proration_behavior":{"$ref":"#/components/schemas/ProrationEnum","default":"always_invoice","description":"Determines how to handle prorations when the subscription is resumed.","example":"always_invoice"}},"title":"SubscriptionResumeRequest","type":"object"},"SubscriptionStatusEnum":{"enum":["incomplete","trialing","active","paused","past_due","canceled","scheduled"],"title":"SubscriptionStatusEnum","type":"string"},"TaxIdSetting":{"properties":{"tax_id":{"description":"The tax ID value","title":"Tax Id","type":"string"},"tax_id_type":{"description":"The type code for this tax ID","title":"Tax Id Type","type":"string"}},"required":["tax_id_type","tax_id"],"title":"TaxIdSetting","type":"object"},"TaxIdType":{"properties":{"description":{"description":"Human readable description of this tax ID type","title":"Description","type":"string"},"example":{"description":"Example of a valid tax ID of this type","title":"Example","type":"string"},"tax_id_type":{"$ref":"#/components/schemas/TaxIdTypeEnum","description":"The type code for this tax ID"}},"required":["tax_id_type","description","example"],"title":"TaxIdType","type":"object"},"TaxIdTypeEnum":{"description":"Enum for all supported tax ID types.","enum":["al_tin","ad_nrt","ao_tin","ar_cuit","am_tin","au_abn","au_arn","eu_vat","bs_tin","bh_vat","bb_tin","by_tin","bo_tin","ba_tin","br_cnpj","br_cpf","bg_uic","kh_tin","ca_bn","ca_gst_hst","ca_pst_bc","ca_pst_mb","ca_pst_sk","ca_qst","cl_tin","cn_tin","co_nit","cd_nif","cr_tin","hr_oib","do_rcn","ec_ruc","eg_tin","sv_nit","eu_oss_vat","de_stn","ge_vat","gn_nif","hk_br","hu_tin","is_vat","in_gst","id_npwp","il_vat","jp_cn","jp_rn","jp_trn","kz_bin","ke_pin","li_uid","li_vat","my_frp","my_itn","my_sst","mr_nif","mx_rfc","md_vat","me_pib","ma_vat","np_pan","nz_gst","ng_tin","mk_vat","no_vat","no_voec","om_vat","pe_ruc","ph_tin","ro_tin","ru_inn","ru_kpp","sa_vat","sn_ninea","rs_pib","sg_gst","sg_uen","si_tin","za_vat","kr_brn","es_cif","sr_fin","ch_uid","ch_vat","tw_vat","tj_tin","tz_vat","th_vat","tr_tin","ug_tin","ua_vat","ae_trn","gb_vat","us_ein","uy_ruc","uz_tin","uz_vat","ve_rif","vn_tin","zm_tin","zw_tin"],"title":"TaxIdTypeEnum","type":"string"},"TaxIntegrationApiName":{"enum":["anrok_v1"],"title":"TaxIntegrationApiName","type":"string"},"TaxIntegrationExternal":{"properties":{"accounting_tz":{"description":"The timezone name for the accounting timezone (see pytz.all_timezones for a full list)","example":"US/Pacific","title":"Accounting Tz","type":"string"},"api_keys":{"description":"These keys will allow to authenticate API requests to the tax processor.","example":{"api_key":"00000000000/aaaaaaaaaaaaa/secret.ZZZZZZZZZZZZZZZZZZZZZZZZZZ"},"title":"Api Keys","type":"object"},"api_name":{"$ref":"#/components/schemas/TaxIntegrationApiName","description":"The name of the API used for the tax integration.","example":"anrok_v1"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"id":{"description":"Unique Identifier of the tax integration.","example":"taxintg_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"object":{"$ref":"#/components/schemas/ObjectName","default":"tax_integration"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","api_name","api_keys","accounting_tz"],"title":"TaxIntegrationExternal","type":"object"},"TokenizedCreditCardExternal":{"properties":{"billing_address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"The card's billing address.","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"card_brand":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. VISA, AMERICAN_EXPRESS, EBT, DISCOVER","example":"VISA","title":"Card Brand"},"card_country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"isoCode2 card country of origin","example":"US","title":"Card Country"},"card_fingerprint":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"fingerprint of the card","example":"9bbef19476623ca56c17da75fd57734dbf82530686043a6e491c6d71befe8f6e","title":"Card Fingerprint"},"card_iin":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"first 6 digits of the card","example":"411111","title":"Card Iin"},"card_issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the bank","example":"Chase","title":"Card Issuer"},"card_type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CREDIT, DEBIT, CHARGE CARD","example":"CREDIT","title":"Card Type"},"cde_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Metadata about the card w.r.t. CDE","example":"cde_1234567890abcdef","title":"Cde External Id"},"created_at":{"description":"DateTime at which the object was created, in 'ISO 8601' format.","format":"date-time","title":"Created At","type":"string"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the Customer to which this PaymentMethod is attached.","examples":["cus_dev_123"],"title":"Customer Id"},"display_name":{"description":"Display name for the payment method to show on the UI.","title":"Display Name","type":"string"},"expiry_date":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Expiry Date of your card. (%Y-%m)","title":"Expiry Date"},"id":{"description":"Unique Identifier of the payment_method.","example":"pm_dev_abc123","title":"Id","type":"string"},"is_deleted":{"default":false,"description":"If true, indicates that this object has been deleted","title":"Is Deleted","type":"boolean"},"is_full_details_known":{"description":"Indicates if full details of the card are known","example":true,"title":"Is Full Details Known","type":"boolean"},"last_four":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Last four digits of this card","example":"8726","title":"Last Four"},"mappings":{"default":[],"description":"List of payment method mappings associated with this payment method. Include \"mappings\" in the expand parameter to retrieve this data.","items":{"$ref":"#/components/schemas/PaymentMethodMappingExternal"},"title":"Mappings","type":"array"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","title":"Metadata"},"object":{"$ref":"#/components/schemas/ObjectName","default":"tokenized_card_payment_method"},"provider":{"$ref":"#/components/schemas/PaymentProviderType","description":"The provider type for this payment method","example":"credit_card"},"updated_at":{"description":"DateTime at which the object was updated, in 'ISO 8601' format.","format":"date-time","title":"Updated At","type":"string"}},"required":["id","created_at","updated_at","provider","display_name","expiry_date","is_full_details_known"],"title":"TokenizedCreditCardExternal","type":"object"},"UpdateChargeRequest":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with charge.","examples":[null],"title":"Custom Fields"}},"title":"UpdateChargeRequest","type":"object"},"UpdateCouponRequest":{"description":"Coupons are largely immutable by design, discounts refer back to their coupons\nwhenever they are applied to invoice","properties":{"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"Whether the coupon is available to be redeemed.","example":true,"title":"Is Active"},"max_redemptions":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"type":"null"}],"description":"A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.","example":5,"title":"Max Redemptions"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the coupon displayed to customers on, for instance invoices, or receipts.","example":"Christmas day 20% coupon","title":"Name"},"redeem_by":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"Datetime specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.","title":"Redeem By"}},"title":"UpdateCouponRequest","type":"object"},"UpdateCustomerRequest":{"properties":{"billing_email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Billing address of the customer.","title":"Billing Email"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s business name.","example":"ACME LLC","title":"Business Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"City, district, suburb, town, or village.","example":"Los Angeles","title":"City"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country name. If possible two-letter country code.","example":"US","title":"Country"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If you provide a coupon_id, the customer will have a discount applied on all recurring charges. If there is an existing customer, this coupon will override it.","example":"_dev_123","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with customer.","examples":[null],"title":"Custom Fields"},"customer_billing_address":{"anyOf":[{"$ref":"#/components/schemas/CompleteAddress"},{"type":"null"}],"description":"Customer's billing address","example":{"city":"Los Angeles","country":"US","line1":"123 Sparrow Street","line2":"Unit 8","line3":"","state":"California","zip_code":"90001"}},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email of the customer.","examples":[null],"title":"Email"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s first name.","example":"john","title":"First Name"},"invoice_settings":{"anyOf":[{"$ref":"#/components/schemas/CustomerInvoiceSettings"},{"type":"null"}],"description":"Invoice settings for the customer."},"language":{"anyOf":[{"$ref":"#/components/schemas/CustomerLanguage"},{"type":"null"}],"description":"Language of the customer."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The customer’s last name.","example":"doe","title":"Last Name"},"line1":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 1.","example":"123 Sparrow Street","title":"Line1"},"line2":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 2.","example":"Unit 8","title":"Line2"},"line3":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Address line 3.","example":"","title":"Line3"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Free form notes about the customer.","example":"Customer answered survey on 08-03","title":"Notes"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Phone number of the customer.","title":"Phone Number"},"promotion_code_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The API ID of a promotion code to apply to the customer. This is not PromotionCode alphabetic code. PromotionCode with restrictions cannot be redeemed on a customer. The customer will have a discount applied on all recurring payments. This is effectively same as proving Coupon attached to the promotion_code. If there is an existing customer, this will override it.","example":"promo_dev_123","title":"Promotion Code Id"},"shipping_addresses":{"default":[],"description":"List of the customer’s shipping addresses.","items":{"$ref":"#/components/schemas/CompleteAddress"},"title":"Shipping Addresses","type":"array"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"State, province, or region.","example":"California","title":"State"},"zip_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ZIP or postal code.","example":"90001","title":"Zip Code"}},"title":"UpdateCustomerRequest","type":"object"},"UpdateInvoiceRequest":{"properties":{"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this invoice. Pass 'none' to remove discount.","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with invoice.","examples":[null],"title":"Custom Fields"},"description":{"default":"Manual creation of invoice","description":"Description for newly created invoice","example":"Invoice to acme.co","title":"Description","type":"string"},"email_invoice_on_finalization":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether invoice should be sent to the customer upon finalizing the invoice.","examples":[false],"title":"Email Invoice On Finalization"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the payment method.","example":"pm_dev_abc123","title":"Payment Method Id"}},"title":"UpdateInvoiceRequest","type":"object"},"UpdatePaymentIntent":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with payment intent.","examples":[null],"title":"Custom Fields"}},"title":"UpdatePaymentIntent","type":"object"},"UpdatePriceRequest":{"properties":{"aggregate_usage":{"anyOf":[{"$ref":"#/components/schemas/UsageAggMethodEnum"},{"type":"null"}],"description":"Specifies a usage aggregation strategy for prices of usage_type 'metered'.","example":"sum"},"billing_interval":{"anyOf":[{"$ref":"#/components/schemas/CalendarIntervalEnum"},{"type":"null"}],"description":"The interval unit for billing within the contract term (e.g., month, quarter).","example":"month"},"billing_interval_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The number of billing interval units between billing cycles.","example":3,"title":"Billing Interval Count"},"can_only_be_purchased_with":{"description":"This price can only be purchased in a subscription if subscriptioncontains at least one of these prices.","example":["price_dev_45ds7","price_dev_s8sh"],"items":{"type":"string"},"title":"Can Only Be Purchased With","type":"array"},"contract_auto_renew":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not the contract auto-renews at the end of its term.","example":true,"title":"Contract Auto Renew"},"contract_term_multiple":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Defines a multiple on top of billing_interval, billing_interval_count for which this price should be under contract for.","example":4,"title":"Contract Term Multiple"},"currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyEnum"},{"type":"null"}],"description":"Three-letter ISO currency code, in lowercase.","examples":["usd"]},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach to the price.","title":"Custom Fields"},"default_net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of days a customer has to pay invoices generated from this price.If there are multiple prices in the invoice the minimum net-d will be respected.Value should be within -1 to 365, where -1 represents DUE_IMMEDIATELY.","example":-1,"title":"Default Net D"},"internal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary string describing this price.","title":"Internal Description"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the price can be used for new purchases.","example":true,"title":"Is Active"},"is_exclusive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"If true, this price is listed exclusively for customers in the `listed_exclusively_for_customers` field.Defaults to False (not exclusive).","example":false,"title":"Is Exclusive"},"listed_exclusively_for_customers":{"description":"When listed_exclusively_for_customers is passed only customers under listed_exclusively_for_customers can list the given price. Anyone who has a payment_link containing the price can view and subscribe the prices regardless of it.Please do not pass a value if a price is not exclusive.","example":["cus_dev_abc123","cus_dev_def456"],"items":{"type":"string"},"title":"Listed Exclusively For Customers","type":"array"},"meta":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of key-value pairs to attach with price.","title":"Meta"},"meter_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of meter tracking the usage of a metered price.","title":"Meter Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of the price.","title":"Name"},"price_tiers":{"description":"List of price_tiers.","example":[{"flat_amount_atom":0,"unit_amount_atom":100,"units_from":1,"units_upto":10},{"unit_amount_atom":90,"units_from":11}],"items":{"$ref":"#/components/schemas/PriceTierParams"},"title":"Price Tiers","type":"array"},"price_type":{"anyOf":[{"$ref":"#/components/schemas/PriceTypeEnum"},{"type":"null"}],"description":"One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.","example":"recurring"},"pricing_model":{"anyOf":[{"$ref":"#/components/schemas/PricingModel"},{"type":"null"}],"description":"Indicates which pricing model to be used for product.","example":"standard"},"transform_quantity_divide_by":{"anyOf":[{"type":"number"},{"type":"null"}],"default":1,"description":"This transformation will be applied on quantity before multiplying by unit_amount_atom.","example":1,"title":"Transform Quantity Divide By"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of trail days for this Price.","example":7,"title":"Trial Period Days"},"unit_amount_atom":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The unit amount in atomic units (in USD this is cents) to be charged.","example":100,"title":"Unit Amount Atom"},"usage_type":{"anyOf":[{"$ref":"#/components/schemas/UsageTypeEnum"},{"type":"null"}],"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'.","example":"licensed"}},"title":"UpdatePriceRequest","type":"object"},"UpdateProductFamilyRequest":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A description of the product family.","example":"The best CRM catalog.","title":"Description"},"hierarchy":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"{}","description":"A JSON object representing the hierarchy within the family.","example":"{\"product_abc13\": 1, \"product_abd48\": 2}","title":"Hierarchy"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of the product family.","example":"CRM products","title":"Name"},"products":{"description":"List of unique id's for the products in this family.","example":["product_abc13","product_abd48"],"items":{"type":"string"},"title":"Products","type":"array"}},"required":["name","products"],"title":"UpdateProductFamilyRequest","type":"object"},"UpdateProductRequest":{"properties":{"account_sku":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"SKU for given product. eg. Barcode numbers of inventory item.","example":"abc123","title":"Account Sku"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with product.","examples":[null],"title":"Custom Fields"},"default_price_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique identifier of the default price.","example":123,"title":"Default Price Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Product's description.","example":"This is description for product1","title":"Description"},"features":{"description":"List of product features.","example":["feature1 of product1","feature2 of product1"],"items":{"type":"string"},"title":"Features","type":"array"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not this product is accepting new subscriptions.","example":true,"title":"Is Active"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Name of product.","example":"product1","title":"Name"},"unit_label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label that represents units of this product.","example":"piece","title":"Unit Label"}},"title":"UpdateProductRequest","type":"object"},"UpdatePromoCodeRequest":{"properties":{"is_active":{"description":"Whether the promotion code is currently active. A promotion code can only be reactivated when the coupon is still valid and the promotion code is otherwise redeemable.","title":"Is Active","type":"boolean"}},"required":["is_active"],"title":"UpdatePromoCodeRequest","type":"object"},"UpdateSubscriptionItemRequest":{"properties":{"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with subscription item.","title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Description for the subscription item being updated.","title":"Description"},"drop_at_end":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A flag that, if set to true, will drop the subscription item from subscription when renewing subscription. delete flag can not be used while using this behaviour","example":false,"title":"Drop At End"},"price_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the price. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.","example":"price_dev_abc123","title":"Price Id"},"proration_behavior":{"$ref":"#/components/schemas/ProrationEnum","default":"always_invoice","description":"Determines how to handle prorations when the billable items changes. In case of subscription is in trialing state, invoice items if any will be for amount_atom 0.","example":"always_invoice"},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The quantity you'd like to apply to the subscription item you're updating.","example":2,"title":"Quantity"}},"title":"UpdateSubscriptionItemRequest","type":"object"},"UpdateSubscriptionRequest":{"properties":{"cancel_at_end":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Boolean indicating whether this subscription should cancel at the end of the current period.","example":false,"title":"Cancel At End"},"collection_method":{"anyOf":[{"$ref":"#/components/schemas/CollectionMethodEnum"},{"type":"null"}],"description":"Invoices generated by this subscription can either be charged automatically or can be sent to customer for payment. The latter is not automatically charged.","example":"charge_automatically"},"coupon_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the coupon to apply to this subscription. The coupon will also be applied to any subscriptions spawned during update call. Pass 'none' to remove discount.","title":"Coupon Id"},"custom_fields":{"anyOf":[{"type":"object"},{"type":"null"}],"description":"Set of custom key-value pairs to attach with subscription.","examples":[null],"title":"Custom Fields"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Arbitrary String describing this subscription.","example":"Updated description of the subscription.","title":"Description"},"is_preview":{"default":false,"description":"Whether the request is in preview mode (subscriptions won't actually be updated)","example":false,"title":"Is Preview","type":"boolean"},"items":{"description":"A list of up to 20 subscription items, each with an attached price.","example":[{"delete":false,"id":"subi_dev_abc123","price_id":"price_dev_abc123","quantity":2}],"items":{"$ref":"#/components/schemas/InlineSubscriptionItemUpdate"},"title":"Items","type":"array"},"net_d":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Number of days the customer has to pay the invoice, from 0 to 365, where -1 indicates due immediately. If unset, net-d from Price will apply.","example":-1,"title":"Net D"},"new_period_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"New period end for the subscription.","examples":[null],"title":"New Period End"},"payment_method_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ID of the default payment method for the subscription. It must belong to the customer associated with the subscription.","example":"pm_dev_abc123","title":"Payment Method Id"},"preview_renewal_invoices":{"default":false,"description":"Whether to include the preview of the renewal invoices for the subscriptions in the response.","example":false,"title":"Preview Renewal Invoices","type":"boolean"},"promotion_code":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The promotion code to apply to this subscription. The promotion code will also be applied to any subscriptions spawned during update call.","example":"flat-10-pc-off","title":"Promotion Code"},"proration_behavior":{"$ref":"#/components/schemas/ProrationEnum","default":"always_invoice","description":"Determines how to handle prorations when the billable items changes","example":"always_invoice"},"trial_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}],"description":"ISO datetime representing the end of the trial period the customer will get before being charged for the first time. The operation is only allowed for currently trialing subscriptions","title":"Trial End"},"trial_period_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Integer representing the number of trial period days before the customer is charged for the first time. This are additional days from now, and overwrites current trial_end. The operation is only allowed for currently trialing subscriptions","title":"Trial Period Days"}},"title":"UpdateSubscriptionRequest","type":"object"},"UpdateSubscriptionResponse":{"properties":{"invoices":{"description":"List of invoices created","items":{"$ref":"#/components/schemas/InvoiceExternal"},"title":"Invoices","type":"array"},"renewal_invoices":{"default":[],"description":"List of renewal invoices created","examples":[[]],"items":{"$ref":"#/components/schemas/InvoiceExternal"},"title":"Renewal Invoices","type":"array"},"subscriptions":{"description":"List of subscriptions updated.","example":[{"account_id":"account_dev_abc123","cancel_at_end":false,"cancellation_details":{},"current_period_end":"2023-11-02T08:49:54.678156Z","current_period_start":"2023-10-02T08:49:54.678156Z","custom_fields":{},"customer_id":"cus_dev_abc123","default_payment_method_id":"pm_dev_abc123","description":"Description of this subcription.","id":"subscription_dev_abc123","initial_start":"2023-10-02T08:49:54.678156Z","status":"active","subscription_items":[{"deleted":false,"id":"subi_dev_abc123","price_id":"price_dev_abc123","quantity":2,"subscription_id":"subscription_dev_abc123"}]}],"items":{"$ref":"#/components/schemas/SubscriptionExternal"},"title":"Subscriptions","type":"array"}},"required":["subscriptions","invoices"],"title":"UpdateSubscriptionResponse","type":"object"},"UsageAggMethodEnum":{"enum":["sum","last_during_period","last_ever","max"],"title":"UsageAggMethodEnum","type":"string"},"UsageTypeEnum":{"enum":["metered","licensed"],"title":"UsageTypeEnum","type":"string"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"WebhookDeliveryResult":{"properties":{"attempt_time":{"description":"Webhook delivery attempt time in 'ISO 8601' format.","example":"2025-04-02T08:49:54.678156Z","format":"date-time","title":"Attempt Time","type":"string"},"event_id":{"description":"Unique id for the event which was sent to the webhook url.","example":"event_dev_abc123","title":"Event Id","type":"string"},"response_code":{"description":"HTTP response code received upon attempted delivery to webhook endpoint","title":"Response Code","type":"integer"},"response_text":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Response text received from the delivery attempt","title":"Response Text"},"webhook_id":{"description":"Unique id for the webhook url to which the event was sent.","example":"webhook_endpoint_dev_abc123","title":"Webhook Id","type":"string"}},"required":["webhook_id","event_id","attempt_time","response_code"],"title":"WebhookDeliveryResult","type":"object"}},"securitySchemes":{"HTTPBearer":{"scheme":"bearer","type":"http"}}},"info":{"description":"super charge your subscription management.","title":"OpenPay API","version":"1.2.3"},"openapi":"3.1.0","paths":{"/billing/meter-event-adjustments/":{"post":{"description":"Creates a billing meter event adjustment to cancel a previously sent billing meter event.","operationId":"create_billing_meter_event_adjustments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingMeterEventAdjustmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterEventAdjustmentExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Billing Meter Event Adjustments","tags":["billing_meter_event_adjustments"],"x-codeSamples":[{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter_event_adjustments","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_event_adjustments.create_billing_meter_event_adjustments(cancel_identifier=\"\", event_name=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_billing_meter_event_adjustments","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeterEventAdjustments.CreateBillingMeterEventAdjustments(ctx, shared.CreateBillingMeterEventAdjustmentRequest{\n CancelIdentifier: \"\",\n EventName: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterEventAdjustmentExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event_adjustments","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEventAdjustments.createBillingMeterEventAdjustments({\n cancelIdentifier: \"\",\n eventName: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter_event_adjustments","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_event_adjustments.create_billing_meter_event_adjustments(cancel_identifier=\"\", event_name=\"\")\n\n # Handle response\n print(res)"}]}},"/billing/meter-events/":{"post":{"description":"A billing meter event represents a customer’s usage of a product. Meter events are used to\nbill a customer based on their usage. Meter events are associated with billing meters,\nwhich define the shape of the event’s payload and how those events are aggregated for billing.\nEvery event is identified by an unique identifier, same identifier can not be used again.","operationId":"create_billing_meter_event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingMeterEventRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterEventExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Billing Meter Event","tags":["billing_meter_events"],"x-codeSamples":[{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter_event","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\nfrom openpay_openpay_api_python.utils import parse_datetime\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_events.create_billing_meter_event(event_name=\"metered_event_x\", payload={}, event_datetime=parse_datetime(\"2023-10-02T08:49:54.678156Z\"), identifier=\"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_billing_meter_event","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"openpay-api-go/pkg/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeterEvents.CreateBillingMeterEvent(ctx, shared.CreateBillingMeterEventRequest{\n EventDatetime: types.MustNewTimeFromString(\"2023-10-02T08:49:54.678156Z\"),\n EventName: \"metered_event_x\",\n Identifier: openpayapigo.String(\"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\"),\n Payload: shared.Payload{},\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterEventExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter_event","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.createBillingMeterEvent({\n eventDatetime: new Date(\"2023-10-02T08:49:54.678156Z\"),\n eventName: \"metered_event_x\",\n identifier: \"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\",\n payload: {},\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter_event","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\nfrom openpay_openpay_api_python.utils import parse_datetime\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_events.create_billing_meter_event(event_name=\"metered_event_x\", payload={}, event_datetime=parse_datetime(\"2023-10-02T08:49:54.678156Z\"), identifier=\"8091436b-2eb8-49ef-8a11-bd23b6cf81ef\")\n\n # Handle response\n print(res)"}]}},"/billing/meter-events/list":{"post":{"description":"A billing meter event summary represents an aggregated view of a customer’s billing meter\nevents within a specified timeframe. It indicates how much usage was accrued by\na customer for that period.","operationId":"list_billing_meter_event_summaries","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBillingMeterEventSummariesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_BillingMeterSummary_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Billing Meter Event Summaries","tags":["billing_meter_events"],"x-codeSamples":[{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_billing_meter_event_summaries","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\nfrom openpay_openpay_api_python.utils import parse_datetime\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_events.list_billing_meter_event_summaries(customer_id=\"\", end_time=parse_datetime(\"2025-04-30T22:54:50.111Z\"), meter_id=\"\", start_time=parse_datetime(\"2025-02-01T00:13:23.015Z\"))\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_billing_meter_event_summaries","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"openpay-api-go/pkg/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeterEvents.ListBillingMeterEventSummaries(ctx, shared.ListBillingMeterEventSummariesRequest{\n CustomerID: \"\",\n EndTime: types.MustTimeFromString(\"2025-04-30T22:54:50.111Z\"),\n MeterID: \"\",\n StartTime: types.MustTimeFromString(\"2025-02-01T00:13:23.015Z\"),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseBillingMeterSummary != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meter_event_summaries","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeterEvents.listBillingMeterEventSummaries({\n customerId: \"\",\n endTime: new Date(\"2025-04-30T22:54:50.111Z\"),\n meterId: \"\",\n startTime: new Date(\"2025-02-01T00:13:23.015Z\"),\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_billing_meter_event_summaries","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\nfrom openpay_openpay_api_python.utils import parse_datetime\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meter_events.list_billing_meter_event_summaries(customer_id=\"\", end_time=parse_datetime(\"2025-04-30T22:54:50.111Z\"), meter_id=\"\", start_time=parse_datetime(\"2025-02-01T00:13:23.015Z\"), page_number=1, page_size=100)\n\n # Handle response\n print(res)"}]}},"/billing/meters/":{"post":{"description":"Creates a billing meter.\nA billing meter is a resource that allows you to track usage of a particular event.\n For example, you might create a billing meter to track the number of API calls made by\n a particular user.\nYou can then attach the billing meter to a price and attach the price to a subscription\n to charge the user for the number of API calls they make.","operationId":"create_billing_meter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBillingMeterRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Billing Meter","tags":["billing_meters"],"x-codeSamples":[{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.create_billing_meter(display_name=\"meter_x\", event_name=\"metered_event_x\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_billing_meter","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeters.CreateBillingMeter(ctx, shared.CreateBillingMeterRequest{\n DisplayName: \"meter_x\",\n EventName: \"metered_event_x\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.createBillingMeter({\n displayName: \"meter_x\",\n eventName: \"metered_event_x\",\n eventPayloadValueKey: \"bytes_used\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.create_billing_meter(display_name=\"meter_x\", event_name=\"metered_event_x\", event_payload_customer_mapping_key=\"customer_id\", event_payload_value_key=\"bytes_used\")\n\n # Handle response\n print(res)"}]}},"/billing/meters/list":{"post":{"description":"Retrieve a list of billing meters.","operationId":"list_billing_meters","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterQueryParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_BillingMeterExternal_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Billing Meters","tags":["billing_meters"],"x-codeSamples":[{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_billing_meters","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.list_billing_meters(is_active=True)\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_billing_meters","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeters.ListBillingMeters(ctx, shared.BillingMeterQueryParams{\n IsActive: openpayapigo.Bool(true),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseBillingMeterExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_billing_meters","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.listBillingMeters({\n isActive: true,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_billing_meters","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.list_billing_meters(is_active=True, page_number=1, page_size=100, sort_descending=False, sort_key=\"created_at\")\n\n # Handle response\n print(res)"}]}},"/billing/meters/{meter_id}":{"get":{"description":"Retrieves a billing meter given an ID.","operationId":"get_billing_meter","parameters":[{"in":"path","name":"meter_id","required":true,"schema":{"title":"Meter Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Get Billing Meter","tags":["billing_meters"],"x-codeSamples":[{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.get_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"get_billing_meter","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeters.GetBillingMeter(ctx, \"\")\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.getBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.get_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"}]}},"/billing/meters/{meter_id}/deactivate":{"post":{"description":"Deactivates a billing meter.","operationId":"deactivate_billing_meter","parameters":[{"in":"path","name":"meter_id","required":true,"schema":{"title":"Meter Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Deactivate Billing Meter","tags":["billing_meters"],"x-codeSamples":[{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"deactivate_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.deactivate_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"deactivate_billing_meter","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeters.DeactivateBillingMeter(ctx, \"\")\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"deactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.deactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"deactivate_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.deactivate_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"}]}},"/billing/meters/{meter_id}/reactivate":{"post":{"description":"Reactivates a billing meter.","operationId":"reactivate_billing_meter","parameters":[{"in":"path","name":"meter_id","required":true,"schema":{"title":"Meter Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingMeterExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Reactivate Billing Meter","tags":["billing_meters"],"x-codeSamples":[{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"reactivate_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.reactivate_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"reactivate_billing_meter","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingMeters.ReactivateBillingMeter(ctx, \"\")\n if err != nil {\n log.Fatal(err)\n }\n if res.BillingMeterExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"reactivate_billing_meter","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingMeters.reactivateBillingMeter({\n meterId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"reactivate_billing_meter","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_meters.reactivate_billing_meter(meter_id=\"\")\n\n # Handle response\n print(res)"}]}},"/billing_portal/sessions":{"post":{"operationId":"create_portal_session","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSessionExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Portal Session","tags":["billing_portal"],"x-codeSamples":[{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_portal_session","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_portal.create_portal_session(customer_id=\"cust_dev_abc123\", return_url=\"http://example.com/account\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_portal_session","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.BillingPortal.CreatePortalSession(ctx, shared.CreatePortalSessionRequest{\n CustomerID: \"cust_dev_abc123\",\n ReturnURL: \"http://example.com/account\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.PortalSessionExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_portal_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.billingPortal.createPortalSession({\n customerId: \"cust_dev_abc123\",\n returnUrl: \"http://example.com/account\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_portal_session","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.billing_portal.create_portal_session(customer_id=\"cust_dev_abc123\", return_url=\"http://example.com/account\")\n\n # Handle response\n print(res)"}]}},"/charges/list":{"post":{"operationId":"list_charges","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeQueryParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_ChargeExternal_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Charges","tags":["charges"],"x-codeSamples":[{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_charges","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.list_charges()\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_charges","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Charges.ListCharges(ctx, shared.ChargeQueryParams{})\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseChargeExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_charges","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.listCharges({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_charges","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.list_charges(page_number=1, page_size=100, sort_descending=False, sort_key=\"created_at\")\n\n # Handle response\n print(res)"}]}},"/charges/{charge_id}":{"get":{"operationId":"get_charge","parameters":[{"in":"path","name":"charge_id","required":true,"schema":{"title":"Charge Id","type":"string"}},{"description":"Fields to expand in the response. Supported values: 'payment_method', 'subscriptions'","in":"query","name":"expand","required":false,"schema":{"description":"Fields to expand in the response. Supported values: 'payment_method', 'subscriptions'","items":{"type":"string"},"title":"Expand","type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Get Charge","tags":["charges"],"x-codeSamples":[{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_charge","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.get_charge(charge_id=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"get_charge","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Charges.GetCharge(ctx, \"\", nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.ChargeExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.getCharge({\n chargeId: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_charge","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.get_charge(charge_id=\"\")\n\n # Handle response\n print(res)"}]},"put":{"operationId":"update_charge","parameters":[{"in":"path","name":"charge_id","required":true,"schema":{"title":"Charge Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChargeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Update Charge","tags":["charges"],"x-codeSamples":[{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"update_charge","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.update_charge(charge_id=\"\", custom_fields=None)\n\n # Handle response\n print(res)"},{"lang":"go","label":"update_charge","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Charges.UpdateCharge(ctx, \"\", shared.UpdateChargeRequest{\n CustomFields: nil,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ChargeExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_charge","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.charges.updateCharge({\n chargeId: \"\",\n updateChargeRequest: {\n customFields: null,\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"update_charge","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.charges.update_charge(charge_id=\"\", custom_fields=None)\n\n # Handle response\n print(res)"}]}},"/checkout/checkout_attempts/validate/{checkout_attempt_id}":{"get":{"operationId":"validate_checkout_attempt","parameters":[{"description":"The checkout attempt ID","example":"catt_dev_abc123","in":"path","name":"checkout_attempt_id","required":true,"schema":{"description":"The checkout attempt ID","title":"Checkout Attempt Id","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSuccessResponse"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Validate Checkout Attempt","tags":["checkout"],"x-codeSamples":[{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"validate_checkout_attempt","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.validate_checkout_attempt(checkout_attempt_id=\"catt_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"validate_checkout_attempt","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Checkout.ValidateCheckoutAttempt(ctx, \"catt_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.CheckoutSuccessResponse != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"validate_checkout_attempt","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.validateCheckoutAttempt({\n checkoutAttemptId: \"catt_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"validate_checkout_attempt","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.validate_checkout_attempt(checkout_attempt_id=\"catt_dev_abc123\")\n\n # Handle response\n print(res)"}]}},"/checkout/list":{"post":{"operationId":"list_checkout_sessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionQueryParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_CheckoutSessionExternal_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Checkout Sessions","tags":["checkout"],"x-codeSamples":[{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_checkout_sessions","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.list_checkout_sessions()\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_checkout_sessions","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Checkout.ListCheckoutSessions(ctx, shared.CheckoutSessionQueryParams{})\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseCheckoutSessionExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_checkout_sessions","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.listCheckoutSessions({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_checkout_sessions","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.list_checkout_sessions(page_number=1, page_size=100, sort_descending=False, sort_key=\"created_at\")\n\n # Handle response\n print(res)"}]}},"/checkout/sessions":{"post":{"operationId":"create_checkout_session","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCheckoutSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Checkout Session","tags":["checkout"],"x-codeSamples":[{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"subscription\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_checkout_session","source":"import openpay_openpay_api_python\nfrom openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.create_checkout_session(mode=openpay_openpay_api_python.CheckoutMode.SUBSCRIPTION, checkout_preferences={\n \"fallback_cascade_preferences\": [\n {\n \"fallback_processor_preferences\": {\n \"filter_providers\": [],\n \"ids_whitelist\": [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n \"names_whitelist\": [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n \"price_groups\": [\n {\n \"price_id\": \"test_price_id\",\n \"quantity\": 1,\n },\n ],\n },\n ],\n \"fallback_cascade_selected_product_price_quantity\": [\n [\n {\n \"price_id\": \"test_price_id\",\n \"quantity\": 1,\n },\n ],\n ],\n \"processor_preferences\": {\n \"filter_providers\": [\n openpay_openpay_api_python.PaymentProviderType.CREDIT_CARD,\n openpay_openpay_api_python.PaymentProviderType.GOOGLE_PAY,\n ],\n \"ids_whitelist\": [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n \"names_whitelist\": [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n }, client_reference_id=\"your_ref_abc123\", coupon_id=\"coupon_dev_abc123\", customer_email=\"johndoe@xyz.com\", customer_id=\"cus_dev_abc123\", line_items=[\n {\n \"description\": \"Example of a checkout line item description!\",\n \"price_id\": \"price_dev_abc123\",\n \"quantity\": 3,\n },\n ], return_url=\"https://yourwebsite.com/payment/abc123?status=returned\", success_url=\"https://yourwebsite.com/payment/abc123?status=success\", trial_from_price=False, trial_period_days=30)\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_checkout_session","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Checkout.CreateCheckoutSession(ctx, shared.CreateCheckoutSessionRequest{\n CheckoutPreferences: &shared.CheckoutPreferencesCheckoutPreferences{\n FallbackCascadePreferences: []shared.FallbackConfigurationInput{\n shared.FallbackConfigurationInput{\n FallbackProcessorPreferences: &shared.CheckoutProcessorsPreferences{\n FilterProviders: []shared.PaymentProviderType{},\n IdsWhitelist: []string{\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n },\n NamesWhitelist: []string{\n \"stripe\",\n \"authorize_net\",\n },\n },\n PriceGroups: []shared.SelectedPriceQuantity{\n shared.SelectedPriceQuantity{\n PriceID: \"test_price_id\",\n Quantity: 1,\n },\n },\n },\n },\n FallbackCascadeSelectedProductPriceQuantity: [][]shared.SelectedPriceQuantity{\n []shared.SelectedPriceQuantity{\n shared.SelectedPriceQuantity{\n PriceID: \"test_price_id\",\n Quantity: 1,\n },\n },\n },\n ProcessorPreferences: &shared.CheckoutProcessorsPreferences{\n FilterProviders: []shared.PaymentProviderType{\n shared.PaymentProviderTypeCreditCard,\n shared.PaymentProviderTypeGooglePay,\n },\n IdsWhitelist: []string{\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n },\n NamesWhitelist: []string{\n \"stripe\",\n \"authorize_net\",\n },\n },\n },\n ClientReferenceID: openpayapigo.String(\"your_ref_abc123\"),\n CouponID: openpayapigo.String(\"coupon_dev_abc123\"),\n CustomerEmail: openpayapigo.String(\"johndoe@xyz.com\"),\n CustomerID: openpayapigo.String(\"cus_dev_abc123\"),\n LineItems: []shared.CreateCheckoutLineItem{\n shared.CreateCheckoutLineItem{\n Description: openpayapigo.String(\"Example of a checkout line item description!\"),\n PriceID: \"price_dev_abc123\",\n Quantity: 3,\n },\n },\n Mode: shared.CheckoutModeSubscription,\n ReturnURL: openpayapigo.String(\"https://yourwebsite.com/payment/abc123?status=returned\"),\n SuccessURL: openpayapigo.String(\"https://yourwebsite.com/payment/abc123?status=success\"),\n TrialFromPrice: openpayapigo.Bool(false),\n TrialPeriodDays: openpayapigo.Int64(30),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CheckoutSessionExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.createCheckoutSession({\n checkoutPreferences: {\n fallbackCascadePreferences: [\n {\n fallbackProcessorPreferences: {\n filterProviders: [],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n priceGroups: [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n },\n ],\n fallbackCascadeSelectedProductPriceQuantity: [\n [\n {\n priceId: \"test_price_id\",\n quantity: 1,\n },\n ],\n ],\n processorPreferences: {\n filterProviders: [\n \"credit_card\",\n \"google_pay\",\n ],\n idsWhitelist: [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n namesWhitelist: [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n },\n clientReferenceId: \"your_ref_abc123\",\n couponId: \"coupon_dev_abc123\",\n customerEmail: \"johndoe@xyz.com\",\n customerId: \"cus_dev_abc123\",\n lineItems: [\n {\n description: \"Example of a checkout line item description!\",\n priceId: \"price_dev_abc123\",\n quantity: 3,\n },\n ],\n mode: \"payment\",\n returnUrl: \"https://yourwebsite.com/payment/abc123?status=returned\",\n successUrl: \"https://yourwebsite.com/payment/abc123?status=success\",\n trialFromPrice: false,\n trialPeriodDays: 30,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_checkout_session","source":"import openpay_openpay_api_python\nfrom openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.create_checkout_session(mode=openpay_openpay_api_python.CheckoutMode.PAYMENT, checkout_preferences={\n \"fallback_cascade_preferences\": [\n {\n \"fallback_processor_preferences\": {\n \"filter_providers\": [],\n \"ids_whitelist\": [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n \"names_whitelist\": [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n \"price_groups\": [\n {\n \"price_id\": \"test_price_id\",\n \"quantity\": 1,\n },\n ],\n },\n ],\n \"fallback_cascade_selected_product_price_quantity\": [\n [\n {\n \"price_id\": \"test_price_id\",\n \"quantity\": 1,\n },\n ],\n ],\n \"processor_preferences\": {\n \"filter_providers\": [\n openpay_openpay_api_python.PaymentProviderType.CREDIT_CARD,\n openpay_openpay_api_python.PaymentProviderType.GOOGLE_PAY,\n ],\n \"ids_whitelist\": [\n \"pp_dev_abc123\",\n \"pp_dev_def456\",\n ],\n \"names_whitelist\": [\n \"stripe\",\n \"authorize_net\",\n ],\n },\n }, client_reference_id=\"your_ref_abc123\", coupon_id=\"coupon_dev_abc123\", customer_email=\"johndoe@xyz.com\", customer_id=\"cus_dev_abc123\", line_items=[\n {\n \"description\": \"Example of a checkout line item description!\",\n \"price_id\": \"price_dev_abc123\",\n \"quantity\": 3,\n },\n ], return_url=\"https://yourwebsite.com/payment/abc123?status=returned\", success_url=\"https://yourwebsite.com/payment/abc123?status=success\", trial_from_price=False, trial_period_days=30)\n\n # Handle response\n print(res)"}]}},"/checkout/sessions/{checkout_secure_token}/verify_payment_method/{payment_method_id}":{"get":{"description":"Verify that a checkout session and payment method belong to the same customer.","operationId":"verify_checkout_session_payment_method","parameters":[{"description":"The checkout session's secure token","example":"00000000-aaaa-bbbb-cccc-dddddddddddd","in":"path","name":"checkout_secure_token","required":true,"schema":{"description":"The checkout session's secure token","title":"Checkout Secure Token","type":"string"}},{"description":"The payment method ID to verify","example":"cc_dev_abc123","in":"path","name":"payment_method_id","required":true,"schema":{"description":"The payment method ID to verify","title":"Payment Method Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Verify Checkout Session Payment Method","tags":["checkout"],"x-codeSamples":[{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"verify_checkout_session_payment_method","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.verify_checkout_session_payment_method(checkout_secure_token=\"00000000-aaaa-bbbb-cccc-dddddddddddd\", payment_method_id=\"cc_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"verify_checkout_session_payment_method","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Checkout.VerifyCheckoutSessionPaymentMethod(ctx, \"00000000-aaaa-bbbb-cccc-dddddddddddd\", \"cc_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.CheckoutSessionExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"verify_checkout_session_payment_method","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.verifyCheckoutSessionPaymentMethod({\n checkoutSecureToken: \"00000000-aaaa-bbbb-cccc-dddddddddddd\",\n paymentMethodId: \"cc_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"verify_checkout_session_payment_method","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.verify_checkout_session_payment_method(checkout_secure_token=\"00000000-aaaa-bbbb-cccc-dddddddddddd\", payment_method_id=\"cc_dev_abc123\")\n\n # Handle response\n print(res)"}]}},"/checkout/sessions/{session_id}":{"get":{"operationId":"get_checkout_session","parameters":[{"description":"Unique identifier of the checkout session.","example":"cs_dev_abc123","in":"path","name":"session_id","required":true,"schema":{"description":"Unique identifier of the checkout session.","title":"Session Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSessionExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Get Checkout Session","tags":["checkout"],"x-codeSamples":[{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_checkout_session","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.get_checkout_session(session_id=\"cs_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"get_checkout_session","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Checkout.GetCheckoutSession(ctx, \"cs_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.CheckoutSessionExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_checkout_session","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.checkout.getCheckoutSession({\n sessionId: \"cs_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_checkout_session","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.checkout.get_checkout_session(session_id=\"cs_dev_abc123\")\n\n # Handle response\n print(res)"}]}},"/coupons/":{"post":{"operationId":"create_coupon","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCouponRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Coupon","tags":["coupons"],"x-codeSamples":[{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.create_coupon(name=\"\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_coupon","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Coupons.CreateCoupon(ctx, shared.CreateCouponRequest{\n Name: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CouponExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.createCoupon({\n name: \"\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.create_coupon(name=\"\", is_active=True)\n\n # Handle response\n print(res)"}]}},"/coupons/list":{"post":{"operationId":"list_coupons","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponQueryParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_CouponExternal_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Coupons","tags":["coupons"],"x-codeSamples":[{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_coupons","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.list_coupons()\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_coupons","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Coupons.ListCoupons(ctx, shared.CouponQueryParams{})\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseCouponExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_coupons","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.listCoupons({});\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_coupons","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.list_coupons(page_number=1, page_size=100, sort_descending=False, sort_key=\"created_at\")\n\n # Handle response\n print(res)"}]}},"/coupons/{coupon_id}":{"delete":{"operationId":"delete_coupon","parameters":[{"description":"Unique identifier of the Coupon.","example":"coupon_dev_abc123","in":"path","name":"coupon_id","required":true,"schema":{"description":"Unique identifier of the Coupon.","title":"Coupon Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Delete Coupon","tags":["coupons"],"x-codeSamples":[{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"delete_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.delete_coupon(coupon_id=\"coupon_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"delete_coupon","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Coupons.DeleteCoupon(ctx, \"coupon_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Any != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"delete_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.deleteCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"delete_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.delete_coupon(coupon_id=\"coupon_dev_abc123\")\n\n # Handle response\n print(res)"}]},"get":{"operationId":"get_coupon","parameters":[{"description":"Unique identifier of the Coupon.","example":"coupon_dev_abc123","in":"path","name":"coupon_id","required":true,"schema":{"description":"Unique identifier of the Coupon.","title":"Coupon Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Get Coupon","tags":["coupons"],"x-codeSamples":[{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.get_coupon(coupon_id=\"coupon_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"get_coupon","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Coupons.GetCoupon(ctx, \"coupon_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.CouponExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.getCoupon({\n couponId: \"coupon_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.get_coupon(coupon_id=\"coupon_dev_abc123\")\n\n # Handle response\n print(res)"}]},"put":{"operationId":"update_coupon","parameters":[{"description":"Unique identifier of the Coupon.","example":"coupon_dev_abc123","in":"path","name":"coupon_id","required":true,"schema":{"description":"Unique identifier of the Coupon.","title":"Coupon Id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCouponRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Update Coupon","tags":["coupons"],"x-codeSamples":[{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"update_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.update_coupon(coupon_id=\"coupon_dev_abc123\", is_active=True, max_redemptions=5, name=\"Christmas day 20% coupon\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"update_coupon","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.Coupons.UpdateCoupon(ctx, \"coupon_dev_abc123\", shared.UpdateCouponRequest{\n IsActive: openpayapigo.Bool(true),\n MaxRedemptions: openpayapigo.Int64(5),\n Name: openpayapigo.String(\"Christmas day 20% coupon\"),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CouponExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"update_coupon","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.coupons.updateCoupon({\n couponId: \"coupon_dev_abc123\",\n updateCouponRequest: {\n isActive: true,\n maxRedemptions: 5,\n name: \"Christmas day 20% coupon\",\n },\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"update_coupon","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.coupons.update_coupon(coupon_id=\"coupon_dev_abc123\", is_active=True, max_redemptions=5, name=\"Christmas day 20% coupon\")\n\n # Handle response\n print(res)"}]}},"/credit-notes/":{"post":{"description":"Issue a credit note to adjust the amount of a finalized invoice.\nYou may issue multiple credit notes for an invoice.\nThe sum of all credit notes issued for an invoice can’t exceed the\n total amount of the invoice.\nFor a paid invoice, the sum of the refund and credit must equal the invoice total.\nEach credit note will increment the invoice’s pre_payment_credit_notes_amount_atom\n or post_payment_credit_notes_amount_atom depending on its status at the time\n of credit note creation.","operationId":"create_credit_note","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Credit Note","tags":["credit-notes"],"x-codeSamples":[{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_credit_note","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.create_credit_note(invoice_id=\"\", lines=[], total_amount_atom=460071)\n\n # Handle response\n print(res)"},{"lang":"go","label":"create_credit_note","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.CreditNotes.CreateCreditNote(ctx, shared.CreateCreditNoteRequest{\n InvoiceID: \"\",\n Lines: []shared.CreateCreditNoteLine{},\n TotalAmountAtom: 460071,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.CreditNoteExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"create_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.createCreditNote({\n invoiceId: \"\",\n lines: [],\n totalAmountAtom: 460071,\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"create_credit_note","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.create_credit_note(invoice_id=\"\", lines=[], total_amount_atom=460071, credit_amount_atom=0, refund_amount_atom=0)\n\n # Handle response\n print(res)"}]}},"/credit-notes/list":{"post":{"operationId":"list_credit_notes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteQueryParams"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_CreditNoteExternal_"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"List Credit Notes","tags":["credit-notes"],"x-codeSamples":[{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_credit_notes","source":"import openpay_openpay_api_python\nfrom openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.list_credit_notes(request=openpay_openpay_api_python.CreditNoteQueryParams(\n customer_id=\"cus_dev_abc123\",\n invoice_id=\"invoice_dev_abc123\",\n ))\n\n # Handle response\n print(res)"},{"lang":"go","label":"list_credit_notes","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.CreditNotes.ListCreditNotes(ctx, shared.CreditNoteQueryParams{\n CustomerID: openpayapigo.String(\"cus_dev_abc123\"),\n InvoiceID: openpayapigo.String(\"invoice_dev_abc123\"),\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResponseCreditNoteExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"list_credit_notes","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.listCreditNotes({\n customerId: \"cus_dev_abc123\",\n invoiceId: \"invoice_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"list_credit_notes","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.list_credit_notes(customer_id=\"cus_dev_abc123\", invoice_id=\"invoice_dev_abc123\", page_number=1, page_size=100, sort_descending=False, sort_key=\"created_at\")\n\n # Handle response\n print(res)"}]}},"/credit-notes/{credit_note_id}":{"get":{"operationId":"get_credit_note","parameters":[{"description":"Unique Identifier of the credit_note.","example":"credit_note_dev_abc123","in":"path","name":"credit_note_id","required":true,"schema":{"description":"Unique Identifier of the credit_note.","title":"Credit Note Id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Get Credit Note","tags":["credit-notes"],"x-codeSamples":[{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_credit_note","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.get_credit_note(credit_note_id=\"credit_note_dev_abc123\")\n\n # Handle response\n print(res)"},{"lang":"go","label":"get_credit_note","source":"package main\n\nimport(\n\t\"context\"\n\topenpayapigo \"openpay-api-go\"\n\t\"openpay-api-go/pkg/models/shared\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := openpayapigo.New(\n openpayapigo.WithSecurity(shared.Security{\n HTTPBearer: \"\",\n }),\n )\n\n res, err := s.CreditNotes.GetCreditNote(ctx, \"credit_note_dev_abc123\")\n if err != nil {\n log.Fatal(err)\n }\n if res.CreditNoteExternal != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"typescript","label":"get_credit_note","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.creditNotes.getCreditNote({\n creditNoteId: \"credit_note_dev_abc123\",\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"python","label":"get_credit_note","source":"from openpay_openpay_api_python import OpenpayOpenpayAPIPython\n\n\nwith OpenpayOpenpayAPIPython(\n http_bearer=\"\",\n) as ooap_client:\n\n res = ooap_client.credit_notes.get_credit_note(credit_note_id=\"credit_note_dev_abc123\")\n\n # Handle response\n print(res)"}]}},"/customers/":{"post":{"operationId":"create_customer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerExternal"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"security":[{"HTTPBearer":[]}],"summary":"Create Customer","tags":["customers"],"x-codeSamples":[{"lang":"typescript","label":"create_customer","source":"import { OpenpayOpenpayApiTypescript } from \"@openpay/openpay-api-typescript\";\n\nconst openpayOpenpayApiTypescript = new OpenpayOpenpayApiTypescript({\n httpBearer: \"\",\n});\n\nasync function run() {\n const result = await openpayOpenpayApiTypescript.customers.createCustomer({\n businessName: \"ACME LLC\",\n city: \"Los Angeles\",\n country: \"US\",\n couponId: \"