Saltar para o conteúdo
/
Obter Assinatura

Subscriptions API (2.0)

Visão geral

  • 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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/subscriptions/

Token

Operações

Planos

Operações

Produtos

Operações

Subscription management

Operações

Obter Assinaturas

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.

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
Caminho
merchant_idintegerobrigatório

ID de comerciante.

Consulta
offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

limitintegerobrigatório

Limite da quantidade de elementos na página.

user_idstring

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.

Itens Enum"active""canceled""non_renewing"
datetime_fromstring(datetime)

Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação.

datetime_tostring(datetime)

Data de amostra. Use isso para encontrar assinaturas criadas após a solicitação.

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'

Respostas

OK.

Corpoapplication/jsonArray [
charge_amountnumber(float)

Quantia da cobrança.

commentstring

Motivo para a alteração do status da assinatura

currencystring

Moeda da compra. Código de três letras da moeda de acordo com o ISO 4217.

date_createstring(datetime)

A data de criação da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.

date_endstring(datetime)

A data final da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

date_last_chargestring or null(datetime)

A data da última cobrança da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.

date_next_chargestring or null(datetime)

A data da próxima cobrança da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

idinteger

ID de assinatura

planobject
productobject or null
statusstring

Status

Enum"new""active""canceled""non_renewing""freeze"
userobject
]
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": { … }
  }
]

Obter Assinatura

Pedido

Obtém os dados específicos de uma assinatura por ID.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

subscription_idintegerobrigatório

ID de assinatura.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/{subscription_id}'

Respostas

OK.

Corpoapplication/json
charge_amountnumber(float)

Quantia da cobrança.

commentstring

Motivo para a alteração do status da assinatura

currencystring

Moeda da compra. Código de três letras da moeda de acordo com o ISO 4217.

date_createstring(datetime)

A data de criação da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.

date_endstring(datetime)

A data final da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

date_last_chargestring or null(datetime)

A data da última cobrança da assinatura no formato AAAA-MM-DD’T’HH:MM:SS de acordo com o ISO 8601.

date_next_chargestring or null(datetime)

A data da próxima cobrança da assinatura no formato 'AAAA-MM-DD'T'HH:MM:SS', de acordo com o ISO 8601.

idinteger

ID de assinatura

planobject
productobject or null
statusstring

Status

Enum"new""active""canceled""non_renewing""freeze"
userobject
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"
  }
}

Atualizar Assinatura

Pedido

Atualiza uma assinatura alterando seu status (active, canceled, ou non_renewing) ou atrasando a próxima data de cobrança.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

user_idstringobrigatório

ID de usuário.

subscription_idintegerobrigatório

ID de assinatura.

Corpoapplication/jsonobrigatório
cancel_subscription_paymentboolean

Definir como true reembolsará o último pagamento feito desta assinatura. Só funciona junto com a troca do status para canceled.

statusstring

Status.

Enum"active""canceled""non_renewing"
timeshiftobject

Adiamento de cobrança.

xsolla_networkobject
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"
  }'

Respostas

OK.

Corpoapplication/json
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"
  }
}

Pagamentos

Operações

Promoções

Operações

Cupons

Operações

Subscription management

Operações