Saltar para o conteúdo
/
Definir Períodos de Valid...

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 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": [
    { … }
  ]
}

Definir Períodos de Validade

Pedido

Define intervalos de data/hora quando uma promoção é válida. Se a promoção for somente leitura (read_only = true), você não poderá editar períodos existentes, mas poderá adicionar novos.

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
periodsArray of objects

Intervalos de tempo/data.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Respostas

Nenhum conteúdo.

Revisar Promoção

Pedido

Você precisa revisar uma promoção antes de ativá-la. Este método retorna a lista de erros, se houver.

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}/review'

Respostas

OK.

Corpoapplication/jsonArray [
componentstring
messagestring
]
Resposta
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Cupons

Operações

Subscription management

Operações