CAcakto
subscriptions

GET /public_api/subscriptions/

Lista assinaturas da conta com filtros, busca e paginação.

Request

Query parameters

limitinteger

Número de resultados a serem retornados por página.

pageinteger

Número da página a ser retornada.

searchstring

Busca por cliente, produto, oferta, pedido ou pagamento.

ordering'status' | 'amount' | 'paymentMethod' | 'createdAt' | 'updatedAt' | 'canceledAt' | 'next_payment_date'

Ordenação dos resultados.

status'active' | 'inactive' | 'canceled' | 'expired' | 'paused' | 'trial'
  • active - Ativa
  • inactive - Inativa
  • canceled - Cancelada
  • expired - Expirada
  • paused - Pausada
  • trial - Em período de teste

Filtra por status da assinatura.

paymentMethodstring

Filtra por método de pagamento.

current_situation'new' | 'renewed'

Filtra pela situação atual da assinatura.

Response

Lista de assinaturas retornada com sucesso.

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.