ID de comerciante.
Subscriptions API (2.0)
- Versão: 2.0
- Servidores:
https://api.xsolla.com/merchant/v2/
Essa referência API descreve os pontos de extremidade na gerência de assinaturas, cupons e promoções. Para obter mais informações sobre as Assinaturas, veja o guia do produto e o glossário.
Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/
Pedido
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.
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.
Segurança
basicAuth
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/subscriptions
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/subscriptions
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/subscriptions?offset=0&limit=0&user_id=string&project_id%5B%5D=0&plan_id%5B%5D=0&product_id%5B%5D=0&group_id%5B%5D=string&status%5B%5D=active&datetime_from=string&datetime_to=string'OK.
A data de criação da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.
A data final da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.
A data da última cobrança da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.
A data da próxima cobrança da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.
Dados de tentativa de cobrança.
Dados de cobrança.
Descrição do plano. O valor consiste de pares "localization":"plan description".
Dados de término da assinatura.
Dados do período de carência.
Nome do plano. O valor consiste de pares "localization":"plan name".
Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias).
Descrições de itens traduzidas.
Resposta
application/json
[ { "charge_amount": 0.03, "currency": "USD", "date_create": "2013-09-05T15:27:47+04:00", "date_end": "2014-02-06T11:32:48+04:00", "date_last_charge": null, "date_next_charge": null, "id": 45, "plan": { … }, "product": { … }, "status": "canceled", "user": { … } } ]
- https://api.xsolla.com/merchant/v2/projects/{project_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'OK.
A data de criação da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.
A data final da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.
A data da última cobrança da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.
A data da próxima cobrança da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.
Dados de tentativa de cobrança.
Dados de cobrança.
Descrição do plano. O valor consiste de pares "localization":"plan description".
Dados de término da assinatura.
Dados do período de carência.
Nome do plano. O valor consiste de pares "localization":"plan name".
Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias).
Descrições de itens traduzidas.
Resposta
application/json
{ "charge_amount": 0.03, "comment": "The subscription was not extended in due time", "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": "2019-02-06T12:43:04+03:00", "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 249579, "plan": { "external_id": "lowcost", "id": 601 }, "product": { "id": 123456 }, "status": "canceled", "user": { "id": "user1", "name": "John Smith" } }
Corpoapplication/jsonobrigatório
Definir como true reembolsará o último pagamento feito desta assinatura. Só funciona junto com a troca do status para canceled.
Adiamento de cobrança.
ID de colaborador — Identificador de Influenciador ou de rede de afiliados. Você pode encontrá-lo na seção Conta de Distribuidor > Rede de Parcerias > Influenciadores.
- https://api.xsolla.com/merchant/v2/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}' \
-H 'Content-Type: application/json' \
-d '{
"status": "active"
}'Resposta
application/json
{ "charge_amount": 0.03, "currency": "USD", "date_create": "2018-09-21T16:54:59+03:00", "date_end": null, "date_last_charge": "2018-09-21T16:55:05+03:00", "date_next_charge": "2018-09-21T16:55:05+03:00", "id": 24953579, "plan": { "billing_retry": { … }, "charge": { … }, "description": null, "expiration": { … }, "external_id": "lowcost", "grace_period": { … }, "group_id": "newPlans", "id": 66001, "localized_name": null, "name": null, "project_id": 18404, "refund_period": null, "status": { … }, "tags": null, "trial": { … }, "type": "all" }, "product": null, "status": "active", "user": { "id": "jb1", "name": "J.Black" } }