Saltar para o conteúdo
/
Definir Sistemas de Pagam...

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

Promoções

Operações

Obter Sistemas de Pagamento

Pedido

Obtém sistemas de pagamento suportados para uma promoção. Se a lista estiver vazia, a promoção será aplicada a todos os sistemas de pagamento.

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.

promotion_idintegerobrigatório

ID de promoção.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems'

Respostas

OK.

Corpoapplication/json
idinteger
payment_systemsArray of objects

Sistemas de pagamento.

Resposta
application/json
{
  "id": 17840,
  "payment_systems": [
    { … }
  ]
}

Definir Sistemas de Pagamento

Pedido

Define os sistemas de pagamento suportados para uma promoção. Se a lista estiver vazia, a promoção será aplicada a todos os sistemas de pagamento. Se a promoção for somente leitura (read_only = true), você não poderá chamar este método.

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.

promotion_idintegerobrigatório

ID de promoção.

Corpoapplication/jsonobrigatório
payment_systemsArray of objects

Sistemas de pagamento.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

Respostas

Nenhum conteúdo.

Obter Períodos Válidos

Pedido

Obtém intervalos de data/hora em que uma promoção é válida.

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.

promotion_idintegerobrigatório

ID de promoção.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods'

Respostas

OK.

Corpoapplication/json
idinteger
periodsArray of objects

Intervalos de tempo/data.

Resposta
application/json
{
  "id": 17840,
  "periods": [
    { … }
  ]
}

Cupons

Operações

Subscription management

Operações