List subscriptions

curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/subscriptions \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "status": "active",
      "currentPeriodStart": "2024-01-15T10:30:00.000Z",
      "currentPeriodEnd": "2024-02-15T10:30:00.000Z",
      "billingDay": 15,
      "cancelledAt": null,
      "cancellationType": null,
      "refunded": false,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "plan": {
        "name": "Plano Premium Mensal",
        "price": 99.9,
        "currency": "BRL"
      },
      "customer": {
        "name": "John Doe",
        "email": "[email protected]"
      }
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

GET

subscriptions

List subscriptions

curl --request GET \
  --url https://api-global.fastpaybrasil.com/v1/subscriptions \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
      "status": "active",
      "currentPeriodStart": "2024-01-15T10:30:00.000Z",
      "currentPeriodEnd": "2024-02-15T10:30:00.000Z",
      "billingDay": 15,
      "cancelledAt": null,
      "cancellationType": null,
      "refunded": false,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "plan": {
        "name": "Plano Premium Mensal",
        "price": 99.9,
        "currency": "BRL"
      },
      "customer": {
        "name": "John Doe",
        "email": "[email protected]"
      }
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Query Parameters

merchantId

string

Filter by merchant ID

customerId

string

Filter by customer ID

status

enum<string>

Filter by subscription status

Available options:

pending_activation,

active,

cancelled,

paused,

expired

string

Search by customer name, email, or plan name

page

integer

default:1

Page number (starts at 1)

size

integer

default:10

Number of items per page

Response

Successfully retrieved the list of subscriptions

data

object[]

Array of subscriptions in the current page

Show child attributes