Saltar para o conteúdo
/
Definir Assunto

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 Assunto

Pedido

Obtém informações sobre o assunto de uma promoção.

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

Respostas

OK.

Corpoapplication/json
digital_contentsobject or null
itemsArray of objects

Matriz de itens virtuais aos quais a promoção se aplica.

packagesArray of objects or null

Matriz de pacotes de moedas virtuais aos quais a promoção se aplica.

purchaseboolean

Se a promoção se aplica à compra inteira.

subscriptionsobject or null

Planos de assinatura ou produtos aos quais a promoção se aplica.

idinteger
Resposta
application/json
{
  "digital_contents": null,
  "id": 178,
  "items": [
    { … }
  ],
  "packages": null,
  "purchase": false,
  "subscriptions": null
}

Definir Assunto

Pedido

Define o assunto de uma promoção. Se a promoção for somente leitura (read_only = true), você não poderá atualizar o assunto. O assunto pode assumir os seguintes valores: purchase, ou items, ou packages.

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
digital_contentsobject or null
itemsArray of objects

Matriz de itens virtuais aos quais a promoção se aplica.

packagesArray of objects or null

Matriz de pacotes de moedas virtuais aos quais a promoção se aplica.

purchaseboolean

Se a promoção se aplica à compra inteira.

subscriptionsobject or null

Planos de assinatura ou produtos aos quais a promoção se aplica.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

Respostas

Nenhum conteúdo.

Alternar Promoção

Pedido

Alterna o status de uma promoção de enabledpara disabled e vice-versa.

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 PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/toggle'

Respostas

Nenhum conteúdo.

Cupons

Operações

Subscription management

Operações