# Subotiz

> Subotiz Developer Documentation

## Documentation

### Quick Start

- [Overview](https://docs.subotiz.com/en/quick-start/overview.md)
- [Quick Start](https://docs.subotiz.com/en/quick-start/quick-start.md)

#### Environment

- [Subotiz Merchants](https://docs.subotiz.com/en/quick-start/subotiz-merchants.md)
- [Subotiz · PayPal Merchants](https://docs.subotiz.com/en/quick-start/subotiz-paypal-merchants.md)

### Integration Guide

- [Overview](https://docs.subotiz.com/en/integration/overview.md)

#### Checkout

- [Hosted Page](https://docs.subotiz.com/en/integration/hosted.md)
- [Embedded Form](https://docs.subotiz.com/en/integration/embedded-form.md)

#### Payment

- [Embedded Form](https://docs.subotiz.com/en/integration/embedded-form-payment.md)

#### App

- [In-App Integration Guide](https://docs.subotiz.com/en/integration/app.md)

### AI Developer

- [Subotiz MCP](https://docs.subotiz.com/en/ai/mcp.md)
- [Subotiz CLI](https://docs.subotiz.com/en/ai/subotiz-cli.md)

### Developer Resources

- [Payment Error Code](https://docs.subotiz.com/en/resources/payment-error-code.md)

#### SDK

- [Subotiz SDK](https://docs.subotiz.com/en/resources/subotiz-sdk.md)
- [Subotiz A/B Test SDK](https://docs.subotiz.com/en/resources/subotiz-ab-test-sdk.md)

#### Test

- [Test Card](https://docs.subotiz.com/en/resources/test-cards.md)
- [Sandbox Environment](https://docs.subotiz.com/en/resources/sandbox.md)

### Webhook

- [Introduction](https://docs.subotiz.com/en/webhook/introduction-2.md)

#### Event

##### V2

- [Event Types](https://docs.subotiz.com/en/webhook/event-types-1.md)
- [Subscription](https://docs.subotiz.com/en/webhook/subscription-2.md)
- [Trade](https://docs.subotiz.com/en/webhook/trade-2.md)
- [Invoice](https://docs.subotiz.com/en/webhook/invoice-2.md)
- [Refund](https://docs.subotiz.com/en/webhook/refund-2.md)
- [Dispute](https://docs.subotiz.com/en/webhook/dispute-2.md)

##### V1

- [Event Types](https://docs.subotiz.com/en/webhook/event-types.md)
- [Subscription](https://docs.subotiz.com/en/webhook/subscription-1.md)
- [Invoice](https://docs.subotiz.com/en/webhook/invoice.md)
- [Trade](https://docs.subotiz.com/en/webhook/trade-1.md)
- [Refund](https://docs.subotiz.com/en/webhook/refund-1.md)

## API Reference

### Subotiz API

- [Introduction](https://docs.subotiz.com/en/api/introduction-1.md)
- [Authentication](https://docs.subotiz.com/en/api/authentication-1.md)
- [Errors](https://docs.subotiz.com/en/api/errors.md)
- [Metadata](https://docs.subotiz.com/en/api/metadata.md)

#### Product

- [Object](https://docs.subotiz.com/en/api/product-object.md)
- [List Product Categories](https://docs.subotiz.com/en/api/v1-product-list-product-categories.md): List Product Categories
- [Change Product Status](https://docs.subotiz.com/en/api/v1-product-change-product-status.md): Change Product Status
- [List Product Version](https://docs.subotiz.com/en/api/v1-product-list-product-version.md): List Product Version
- [Get Product Version](https://docs.subotiz.com/en/api/v1-product-get-product-version.md): Get Product Version
- [Create Product](https://docs.subotiz.com/en/api/v1-product-create-product.md): Create Product
- [Get Product](https://docs.subotiz.com/en/api/v1-product-get-product.md): Get Product
- [List Produc](https://docs.subotiz.com/en/api/v1-product-list-product.md): List Product

#### Price

- [Object](https://docs.subotiz.com/en/api/price-object.md)
- [Get Price](https://docs.subotiz.com/en/api/v1-price-get-price.md): Get Price detail
- [List Pricing](https://docs.subotiz.com/en/api/v1-price-list-price.md): List Pricing
- [Create Pricing](https://docs.subotiz.com/en/api/v1-price-create-price.md): Create Pricing
- [Get Price Version](https://docs.subotiz.com/en/api/v1-price-get-price-version.md): Get Price Version detail
- [List Pricing Version](https://docs.subotiz.com/en/api/v1-price-list-price-version.md): List Pricing Version
- [Change Pricing Status](https://docs.subotiz.com/en/api/v1-price-change-price-status.md): Change Pricing Status

#### Discount

- [Object](https://docs.subotiz.com/en/api/discount-object.md)
- [Get Discount](https://docs.subotiz.com/en/api/v1-discount-get-discount.md): Get discount detail
- [List Discounts](https://docs.subotiz.com/en/api/v1-discount-list-discount.md): List discounts
- [End Discount](https://docs.subotiz.com/en/api/v1-discount-end-discount.md): End discount

#### Checkout Session

- [Object](https://docs.subotiz.com/en/api/checkout-session-object.md)
- [Create Checkout Session](https://docs.subotiz.com/en/api/v1-checkout-session-create-checkout-session.md): Create Checkout Session
- [List Checkout Session](https://docs.subotiz.com/en/api/v1-checkout-session-list-checkout-session.md): List Checkout Session
- [Get Checkout Session](https://docs.subotiz.com/en/api/v1-checkout-session-get-checkout-session.md): Get Checkout Session
- [Expire Checkout Session](https://docs.subotiz.com/en/api/v1-checkout-session-expire-checkout-session.md): expire a checkout session.

#### Trade

- [Object](https://docs.subotiz.com/en/api/trade-object.md)
- [List Trades](https://docs.subotiz.com/en/api/v1-trade-list-trade.md): List Trades
- [Create Trade](https://docs.subotiz.com/en/api/v1-trade-create-trade.md): Create Trade
- [Get Trade](https://docs.subotiz.com/en/api/v1-trade-get-trade.md): Get Trade

#### Payment

- [Object](https://docs.subotiz.com/en/api/payment-object.md)
- [List Payments by Trade ID](https://docs.subotiz.com/en/api/v1-payment-list-payments-by-trade-id.md): Get payment flow list by trade_id. Returns all payment flows (including retries) for a specific trade.
- [List Payments by Time Range](https://docs.subotiz.com/en/api/v1-payment-query-payments.md): Query payment flows by time range and filters. Supports pagination with cursor-based navigation. Merchants can filter payments by creation time.

#### Invoice

- [Object](https://docs.subotiz.com/en/api/invoice-object.md)
- [List Invoices](https://docs.subotiz.com/en/api/v1-invoice-list-invoice.md): List Invoices
- [Get Invoice](https://docs.subotiz.com/en/api/v1-invoice-get-invoice.md): Get Invoice

#### Subscription

- [Object](https://docs.subotiz.com/en/api/subscription-object.md)
- [Get Subscription](https://docs.subotiz.com/en/api/v1-subscription-get-subscription.md): Get Subscription
- [Update Subscription](https://docs.subotiz.com/en/api/v1-subscription-update-subscription.md): Update Subscription
- [List Subscriptions](https://docs.subotiz.com/en/api/v1-subscription-list-subscription.md): List Subscriptions
- [Record Subscription Usage](https://docs.subotiz.com/en/api/v1-subscription-record-subscription-usage.md): Record Subscription Usage
- [Renewal Subscription](https://docs.subotiz.com/en/api/v1-subscription-renewal-subscription.md): Renewal Subscription
- [Get Subscription Usage](https://docs.subotiz.com/en/api/v1-subscription-get-subscription-usage.md): Get Subscription Usage
- [Cancel Subscription](https://docs.subotiz.com/en/api/v1-subscription-cancel-subscription.md): Cancel Subscription
- [Pause Subscription](https://docs.subotiz.com/en/api/v1-subscription-pause-subscription.md): Pause Subscription
- [Resume Subscription](https://docs.subotiz.com/en/api/v1-subscription-resume-subscription.md): Resume Subscription
- [Update subscription fixed term](https://docs.subotiz.com/en/api/v1-subscription-update-subscription-fixed-term.md): Update subscription fixed term
- [Revoke Cancel Subscription](https://docs.subotiz.com/en/api/v1-subscription-revoke-cancel-subscription.md): Revoke Cancel Subscription
- [Revoke Pending Price Change](https://docs.subotiz.com/en/api/v1-subscription-revoke-price-change.md): Revoke a price change that was scheduled with effective_type=end_of_period and has not taken effect yet. Immediate changes cannot be revoked.
- [Preview Subscription Quantity](https://docs.subotiz.com/en/api/v1-subscription-preview-subscription-quantity.md): Read-only preview of the estimated amount for the next cycle at a given quantity, intended to be shown before a seat change. Only supported for active subscriptions with billing_dimension=quantity. Has no side effects.

#### Customer

- [Object](https://docs.subotiz.com/en/api/customer-object.md)
- [Create Customer](https://docs.subotiz.com/en/api/v1-customer-create-customer.md): Create Customer
- [Update Customer](https://docs.subotiz.com/en/api/v1-customer-update-customer.md): Update Customer
- [Get Customer](https://docs.subotiz.com/en/api/v1-customer-get-customer.md): Get Customer
- [List Customer](https://docs.subotiz.com/en/api/v1-customer-list-customer.md): List Customer
- [Delete Customer](https://docs.subotiz.com/en/api/v1-customer-delete-customer.md): Delete Customer

#### Customer Portal

- [Object](https://docs.subotiz.com/en/api/customer-portal-object.md)
- [Customer Portal Api Auth](https://docs.subotiz.com/en/api/v1-customer-portal-api-auth.md): Customer Portal Api Auth

#### Refund

- [Object](https://docs.subotiz.com/en/api/refund-object.md)
- [Create Refund](https://docs.subotiz.com/en/api/v1-refund-create-refund.md): Create Refund
- [Get Refund](https://docs.subotiz.com/en/api/v1-refund-get-refund.md): Get Refund
- [List Refunds](https://docs.subotiz.com/en/api/v1-refund-list-refund.md): List Refunds

#### Dispute

- [Object](https://docs.subotiz.com/en/api/dispute-object.md)
- [List disputes](https://docs.subotiz.com/en/api/v1-dispute-list-dispute.md): List disputes with filtering and pagination
- [Get dispute details](https://docs.subotiz.com/en/api/v1-dispute-get-dispute.md): Retrieve a single dispute by ID

#### Webhook

- [Object](https://docs.subotiz.com/en/api/webhook-object.md)
- [List Webhook Events](https://docs.subotiz.com/en/api/v1-webhook-list-webhook-event.md): Returns a list of webhook events created via the API only when the callback_url was specified in the request.
- [List Webhook Endpoints](https://docs.subotiz.com/en/api/v1-webhook-list-endpoint.md): List Webhook Endpoints
- [List Webhook Events V2](https://docs.subotiz.com/en/api/v2-webhook-list-event.md): Returns a list of webhook events created with configured endpoints.

## FAQ

### Frequently Asked Questions

- [Workspace Basics](https://docs.subotiz.com/en/faq/workspace-basics.md)
- [Settings](https://docs.subotiz.com/en/faq/settings.md)
- [AI Assistant](https://docs.subotiz.com/en/faq/ai-assistant.md)
- [Products](https://docs.subotiz.com/en/faq/products.md)
- [Subscriptions](https://docs.subotiz.com/en/faq/subscriptions.md)
- [Discounts](https://docs.subotiz.com/en/faq/discounts.md)
- [Customers](https://docs.subotiz.com/en/faq/customers.md)
- [Emails](https://docs.subotiz.com/en/faq/emails.md)
- [Transaction](https://docs.subotiz.com/en/faq/transaction.md)
- [Invoices](https://docs.subotiz.com/en/faq/invoices.md)
- [Finance](https://docs.subotiz.com/en/faq/finance.md)
- [Data](https://docs.subotiz.com/en/faq/data.md)
- [Subotiz Payments](https://docs.subotiz.com/en/faq/subotiz-payments.md)
- [Subotiz Accounts](https://docs.subotiz.com/en/faq/subotiz-accounts.md)

## OpenAPI Specs

- [v1-en](/openapi/v1-en.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (113 pages)](https://docs.subotiz.com/_llms/zh.txt): Documentation for Chinese.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.