> ## Documentation Index > Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt > Use this file to discover all available pages before exploring further. # Danh sách Đăng ký > Lấy danh sách tất cả các đăng ký liên kết với tài khoản của bạn. ## OpenAPI ````yaml get /subscriptions openapi: 3.1.0 info: title: public description: '' license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.105.11 servers: - url: https://test.dodopayments.com/ description: Test Mode Server Host - url: https://live.dodopayments.com/ description: Live Mode Server Host security: [] tags: - name: Products - name: Payments - name: Subscriptions - name: Addons - name: Customers - name: Refunds - name: Disputes - name: Events - name: License Keys - name: Entitlements - name: Licenses - name: Discounts - name: Meters - name: Credit Entitlements - name: Credit Entitlement Balances - name: Outgoing Webhooks - name: Checkout - name: Webhook Events paths: /subscriptions: get: tags: - Subscriptions operationId: list_subscriptions_handler parameters: - name: created_at_gte in: query description: Get events after this created time required: false schema: type: string format: date-time style: form - name: created_at_lte in: query description: Get events created before this time required: false schema: type: string format: date-time style: form - name: page_size in: query description: Page size default is 10 max is 100 required: false schema: type: integer format: int32 minimum: 0 style: form - name: page_number in: query description: Page number default is 0 required: false schema: type: integer format: int32 minimum: 0 style: form - name: customer_id in: query description: Filter by customer id required: false schema: type: string style: form - name: status in: query description: Filter by status required: false schema: type: string enum: - pending - active - on_hold - cancelled - failed - expired style: form - name: brand_id in: query description: filter by Brand id required: false schema: type: string style: form - name: product_id in: query description: Filter by product id required: false schema: type: string style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetSubscriptionsListResponse' '500': description: Something went wrong :( security: - API_KEY: [] x-codeSamples: - lang: JavaScript source: >- import DodoPayments from 'dodopayments'; const client = new DodoPayments({ bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const subscriptionListResponse of client.subscriptions.list()) { console.log(subscriptionListResponse.product_id); } - lang: Python source: |- import os from dodopayments import DodoPayments client = DodoPayments( bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted ) page = client.subscriptions.list() page = page.items[0] print(page.product_id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/dodopayments/dodopayments-go\"\n\t\"github.com/dodopayments/dodopayments-go/option\"\n)\n\nfunc main() {\n\tclient := dodopayments.NewClient(\n\t\toption.WithBearerToken(\"My Bearer Token\"),\n\t)\n\tpage, err := client.Subscriptions.List(context.TODO(), dodopayments.SubscriptionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - lang: Java source: >- package com.dodopayments.api.example; import com.dodopayments.api.client.DodoPaymentsClient; import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient; import com.dodopayments.api.models.subscriptions.SubscriptionListPage; import com.dodopayments.api.models.subscriptions.SubscriptionListParams; public final class Main { private Main() {} public static void main(String[] args) { DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv(); SubscriptionListPage page = client.subscriptions().list(); } } - lang: Kotlin source: >- package com.dodopayments.api.example import com.dodopayments.api.client.DodoPaymentsClient import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient import com.dodopayments.api.models.subscriptions.SubscriptionListPage import com.dodopayments.api.models.subscriptions.SubscriptionListParams fun main() { val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv() val page: SubscriptionListPage = client.subscriptions().list() } - lang: Ruby source: |- require "dodopayments" dodo_payments = Dodopayments::Client.new( bearer_token: "My Bearer Token", environment: "test_mode" # defaults to "live_mode" ) page = dodo_payments.subscriptions.list puts(page) - lang: PHP source: |- subscriptions->list( brandID: 'brand_id', createdAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), createdAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), customerID: 'customer_id', pageNumber: 0, pageSize: 0, productID: 'product_id', status: 'pending', ); var_dump($page); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: |- using System; using DodoPayments.Client; using DodoPayments.Client.Models.Subscriptions; DodoPaymentsClient client = new(); SubscriptionListParams parameters = new(); var page = await client.Subscriptions.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } - lang: Rust source: |- use dodopayments::Client; #[tokio::main] async fn main() -> dodopayments::Result<()> { let client = Client::from_env()?; let result = client .subscriptions() .list() .query(serde_json::json!({})) .await?; println!("{result:?}"); Ok(()) } components: schemas: GetSubscriptionsListResponse: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/SubscriptionListResponseItem' SubscriptionListResponseItem: type: object description: Response struct representing subscription details required: - subscription_id - recurring_pre_tax_amount - tax_inclusive - currency - status - created_at - product_id - quantity - trial_period_days - subscription_period_interval - payment_frequency_interval - subscription_period_count - payment_frequency_count - next_billing_date - previous_billing_date - customer - metadata - discounts - cancel_at_next_billing_date - billing - on_demand properties: billing: $ref: '#/components/schemas/BillingAddress' description: Billing address details for payments cancel_at_next_billing_date: type: boolean description: Indicates if the subscription will cancel at the next billing date cancelled_at: type: - string - 'null' format: date-time description: Cancelled timestamp if the subscription is cancelled created_at: type: string format: date-time description: Timestamp when the subscription was created currency: $ref: '#/components/schemas/Currency' description: Currency used for the subscription payments customer: $ref: '#/components/schemas/CustomerLimitedDetailsResponse' description: Customer details associated with the subscription customer_business_name: type: - string - 'null' description: >- Business / legal name associated with the tax id (B2B). When set this is used on the invoice in place of the customer's personal name. discount_cycles_remaining: type: - integer - 'null' format: int32 description: 'DEPRECATED: Use discounts[].cycles_remaining instead.' discount_id: type: - string - 'null' description: 'DEPRECATED: Use discounts instead.' discounts: type: array items: $ref: '#/components/schemas/DiscountListItem' description: All stacked discounts applied, in order of application metadata: $ref: '#/components/schemas/Metadata' description: Additional custom data associated with the subscription next_billing_date: type: string format: date-time description: >- Timestamp of the next scheduled billing. Indicates the end of current billing period on_demand: type: boolean description: Wether the subscription is on-demand or not payment_frequency_count: type: integer format: int32 description: Number of payment frequency intervals payment_frequency_interval: $ref: '#/components/schemas/TimeInterval' description: Time interval for payment frequency (e.g. month, year) payment_method_id: type: - string - 'null' description: Saved payment method id used for recurring charges previous_billing_date: type: string format: date-time description: >- Timestamp of the last payment. Indicates the start of current billing period product_id: type: string description: Identifier of the product associated with this subscription product_name: type: - string - 'null' description: Name of the product associated with this subscription quantity: type: integer format: int32 description: Number of units/items included in the subscription recurring_pre_tax_amount: type: integer format: int32 description: >- Amount charged before tax for each recurring payment in the currency's smallest unit (cents for USD, yen for JPY, fils for KWD) scheduled_change: oneOf: - type: 'null' - $ref: '#/components/schemas/ScheduledPlanChangeResponse' description: Scheduled plan change details, if any status: $ref: '#/components/schemas/SubscriptionStatus' description: Current status of the subscription subscription_id: type: string description: Unique identifier for the subscription subscription_period_count: type: integer format: int32 description: Number of subscription period intervals subscription_period_interval: $ref: '#/components/schemas/TimeInterval' description: Time interval for the subscription period (e.g. month, year) tax_id: type: - string - 'null' description: Tax identifier provided for this subscription (if applicable) tax_inclusive: type: boolean description: Indicates if the recurring_pre_tax_amount is tax inclusive trial_period_days: type: integer format: int32 description: Number of days in the trial period (0 if no trial) BillingAddress: type: object required: - country properties: city: type: - string - 'null' description: City name country: $ref: '#/components/schemas/CountryCodeAlpha2' description: Two-letter ISO country code (ISO 3166-1 alpha-2) state: type: - string - 'null' description: State or province name street: type: - string - 'null' description: >- Street address including house number and unit/apartment if applicable zipcode: type: - string - 'null' description: Postal code or ZIP code Currency: type: string enum: - AED - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SZL - THB - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW CustomerLimitedDetailsResponse: type: object required: - customer_id - name - email properties: customer_id: type: string description: Unique identifier for the customer email: type: string description: Email address of the customer metadata: $ref: '#/components/schemas/Metadata' description: Additional metadata associated with the customer name: type: string description: Full name of the customer phone_number: type: - string - 'null' description: Phone number of the customer DiscountListItem: type: object description: |- Lightweight discount info for list endpoints. Array order represents position (no explicit position field). required: - discount_id properties: discount_cycles_remaining: type: - integer - 'null' format: int32 description: Remaining billing cycles for this discount on this subscription discount_id: type: string description: The unique discount ID Metadata: type: object additionalProperties: type: string propertyNames: type: string TimeInterval: type: string enum: - Day - Week - Month - Year ScheduledPlanChangeResponse: type: object required: - id - product_id - quantity - effective_at - created_at - addons properties: addons: type: array items: $ref: '#/components/schemas/ScheduledAddonResponse' description: Addons included in the scheduled change created_at: type: string format: date-time description: When this scheduled change was created effective_at: type: string format: date-time description: When the change will be applied id: type: string description: The scheduled plan change ID product_description: type: - string - 'null' description: Description of the product being changed to product_id: type: string description: The product ID the subscription will change to product_name: type: - string - 'null' description: Name of the product being changed to quantity: type: integer format: int32 description: Quantity for the new plan SubscriptionStatus: type: string enum: - pending - active - on_hold - cancelled - failed - expired CountryCodeAlpha2: type: string description: ISO country code alpha2 variant enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - US - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW ScheduledAddonResponse: type: object required: - addon_id - name - quantity properties: addon_id: type: string description: The addon ID name: type: string description: Name of the addon quantity: type: integer format: int32 description: Quantity of the addon securitySchemes: API_KEY: type: http scheme: bearer ````