Saltar para o conteúdo
/
Obter Pagamentos de Usuár...

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

Pagamentos

Operações

Obter Pagamentos

Pedido

Lista todos os pagamentos de assinaturas.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

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.

statusstring

Status da transação.

Enum ValorDescrição
done

O pagamento foi processado com sucesso.

fail

O pagamento não foi processado com sucesso, ou um reembolso foi emitido.

datetime_fromstring(datetime)

Início do período.

datetime_tostring(datetime)

Fim do período.

subscription_idinteger

ID de assinatura.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/payments?offset=0&limit=0&user_id=string&status=done&datetime_from=string&datetime_to=string&subscription_id=0'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 67683,
    "id_payment": 203960,
    "status": "fail",
    "subscription": { … }
  },
  {
    "date_payment": "2015-09-21T17:06:47+03:00",
    "id": 1531,
    "id_payment": 168866,
    "status": "done",
    "subscription": { … }
  }
]

Obter Pagamentos de Usuário

Pedido

Lista todos os pagamentos feitos por um usuário específico.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

user_idstringobrigatório

ID de usuário.

Consulta
statusstring

Status da transação.

Enum ValorDescrição
done

O pagamento foi processado com sucesso.

fail

O pagamento não foi processado com sucesso, ou um reembolso foi emitido.

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.

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.

subscription_idinteger

ID de assinatura.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/users/{user_id}/subscriptions/payments?status=done&offset=0&limit=0&datetime_from=string&datetime_to=string&subscription_id=0'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
[
  {
    "date_payment": "2016-04-05T10:02:01+03:00",
    "id": 6746083,
    "id_payment": 202789960,
    "status": "fail",
    "subscription": { … }
  }
]

Promoções

Operações

Cupons

Operações

Subscription management

Operações