Docs
APIReferênciaAssinaturas

Listar assinaturas

Assinaturas da loja, com status e próxima cobrança.

Permissão da chave: Pedidos › ler.

Autenticação

bearer
headerAuthorizationBearer <chave de API>

Chave de API da loja (Painel › Integrações › Chaves de API)

Parâmetros da URL

status?string
Valor em"ACTIVE""CANCELED""ENDED""INCOMPLETE""PAST_DUE"
customerId?string
state?string
Valor em"active""past_due""ending""incomplete""ended"
productId?string
method?string
Valor em"PIX""PIX_AUTOMATIC""CARD""BOLETO"
q?string
Tamanho1 <= length <= 100

Corpo da resposta

Exemplo de requisição
curl -X GET "https://api.rivoo.gg/v1/subscriptions?status=ACTIVE&customerId=cus_mhexample0000steve00001&state=active&productId=prod_mhexample0000vip00001&method=PIX&q=pedido_123" \  -H "Authorization: Bearer $RIVOO_API_KEY"
Exemplo de resposta
Vazio

Criar assinatura POST

Cria uma assinatura e devolve o link para o comprador autorizar o Pix Automático ou o cartão. **Permissão da chave:** Pedidos › escrever.

Resumo das assinaturas GET

Ativas, receita recorrente do mês e cancelamentos. **Permissão da chave:** Pedidos › ler.