Listar Assinaturas

Obtenha uma lista de todas as assinaturas associadas à sua conta.

GET /subscriptions

JavaScript

JavaScript

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);
}

200

{
  "items": [
    {
      "billing": {
        "city": "<string>",
        "state": "<string>",
        "street": "<string>",
        "zipcode": "<string>"
      },
      "cancel_at_next_billing_date": true,
      "created_at": "2023-11-07T05:31:56Z",
      "customer": {
        "customer_id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "metadata": {},
        "phone_number": "<string>"
      },
      "discounts": [
        {
          "discount_id": "<string>",
          "discount_cycles_remaining": 123
        }
      ],
      "metadata": {},
      "next_billing_date": "2023-11-07T05:31:56Z",
      "on_demand": true,
      "payment_frequency_count": 123,
      "previous_billing_date": "2023-11-07T05:31:56Z",
      "product_id": "<string>",
      "quantity": 123,
      "recurring_pre_tax_amount": 123,
      "subscription_id": "<string>",
      "subscription_period_count": 123,
      "tax_inclusive": true,
      "trial_period_days": 123,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "customer_business_name": "<string>",
      "discount_cycles_remaining": 123,
      "discount_id": "<string>",
      "payment_method_id": "<string>",
      "product_name": "<string>",
      "scheduled_change": {
        "addons": [
          {
            "addon_id": "<string>",
            "name": "<string>",
            "quantity": 123
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "effective_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "product_id": "<string>",
        "quantity": 123,
        "product_description": "<string>",
        "product_name": "<string>"
      },
      "tax_id": "<string>"
    }
  ]
}

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

created_at_gte · string<date-time>

Get events after this created time

created_at_lte · string<date-time>

Get events created before this time

page_size · integer<int32>

Page size default is 10 max is 100

Intervalo obrigatório: x >= 0

page_number · integer<int32>

Page number default is 0

Intervalo obrigatório: x >= 0

customer_id · string

Filter by customer id

status · enum<string>

Filter by status

Opções disponíveis: pending, active, on_hold, cancelled, failed, expired

brand_id · string

filter by Brand id

product_id · string

Filter by product id

Resposta

200

application/json

items · object[] · obrigatório

Show child attributes