Obter Assinaturas

Obter AssinaturasServer-sideAdmin

get/merchants/{merchant_id}/subscriptions

Lists all recurrent subscriptions.

Aviso

Este método de API não pode ser usado sob uma carga alta. A carga máxima é de 20 solicitações por minuto.

Aviso

Esta chamada de API não contém o trajeto-parâmetro project_id, então é preciso usar a chave API que for válida em todos os projetos da empresa para configurar a autorização.

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

ID de comerciante.

query Parameters

limit required	integer Limite da quantidade de elementos na página.
offset	integer Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).
user_id	string ID de usuário.
project_id[]	Array of integers Lista de IDs de projetos.
plan_id[]	Array of integers Lista de IDs de planos de assinatura.
product_id[]	Array of integers Lista de IDs de produto aos quais os planos estão vinculados.
group_id[]	Array of strings Lista de IDs de grupo aos quais os planos estão vinculados.
status[]	Array of strings Status. Items Enum: "active" "canceled" "non_renewing"
datetime_from	string <datetime> Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação.
datetime_to	string <datetime> Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação.

Responses

200

OK.

Request samples

Response samples

application/json

[{"charge_amount": 0.03,
"currency": "USD",
"date_create": "2013-09-05T15:27:47+0400",
"date_end": "2014-02006T11:32:48+0400",
"date_last_charge": null,
"date_next_charge": null,
"email": "test@test.com",
"id": 45,
"plan_id": 12345,
"product_id": null,
"project_id": 12345,
"status": "canceled",
"user": "User1"
}
]