Saltar para o conteúdo
/
Definir Recompensas

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 Recompensas

Pedido

Obtém a lista de recompensas associadas a 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}/rewards'

Respostas

OK.

Corpoapplication/json
idinteger
itemobject

Defina a recompensa para itens virtuais específicos.

packageobject

Defina a recompensa para um pacote de moedas virtuais.

purchaseobject

Defina a recompensa para a compra toda.

subscriptionobject

Define a recompensa de uma assinatura.

Resposta
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Definir Recompensas

Pedido

Define as recompensas para uma promoção. Se a promoção for somente leitura (read_only = true), você não poderá atualizar as recompensas.

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
itemobject

Defina a recompensa para itens virtuais específicos.

packageobject

Defina a recompensa para um pacote de moedas virtuais.

purchaseobject

Defina a recompensa para a compra toda.

subscriptionobject

Define a recompensa de uma assinatura.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards' \
  -H 'Content-Type: application/json' \
  -d '{
    "item": {
      "bonus": [
        {
          "quantity": 2,
          "sku": "1234"
        }
      ],
      "discount": [
        {
          "discount_percent": 5,
          "max_amount": 10,
          "sku": "1234"
        }
      ]
    },
    "package": {
      "bonus_amount": 5,
      "bonus_percent": 5
    },
    "purchase": {
      "discount_percent": 10
    },
    "subscription": {
      "trial_days": 30
    }
  }'

Respostas

Nenhum conteúdo.

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
}

Cupons

Operações

Subscription management

Operações