Saltar para o conteúdo
/
Ativar Plano

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

Desativar Plano

Pedido

Desativa um plano de assinatura.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

plan_idintegerobrigatório

ID de plano.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

Respostas

Nenhum conteúdo.

Ativar Plano

Pedido

Ative um plano de assinatura.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

plan_idintegerobrigatório

ID de plano.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

Respostas

Nenhum conteúdo.

Atualizar Plano

Pedido

Atualiza os parâmetros do plano de assinatura.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

plan_idintegerobrigatório

ID de plano.

Corpoapplication/jsonobrigatório
billing_retryobject

Dados de tentativa de cobrança.

billing_retry.​valueintegerobrigatório

Quantidade de tentativas de cobrança.

chargeobject

Dados de cobrança.

charge.​amountnumber(float)

Quantia da cobrança.

charge.​currencystring

Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.

charge.​periodobjectobrigatório

Período de cobrança.

charge.​period.​typestringobrigatório

Unidade de tempo. Pode ser day, month ou lifetime.

Enum"day""month""lifetime"
charge.​period.​valueintegerobrigatório

Quantidade de unidades de tempo. O valor depende do parâmetro do tipo e pode ser:
- entre 1 e 366, se type for day
- entre 1 e 12, se type for month
- 0 se type for lifetime

charge.​pricesArray of objects

Lista de preços em moedas diferentes.

charge.​prices[].​amountnumber(float)obrigatório

Quantia da cobrança.

charge.​prices[].​currencystringobrigatório

Moeda da compra. Código da moeda de três letras de acordo com o ISO 4217.

charge.​prices[].​setup_feenumber(float)

Cobrança única de configuração realizada como parte da primeira fatura.

descriptionobject

Descrição do plano. O valor consiste de pares "localization":"plan description".

description.​arstring

Árabe.

description.​bgstring

Búlgaro.

description.​cnstring

Chinês (Simplificado).

description.​csstring

Tcheco.

description.​destring

Alemão.

description.​enstring

Inglês.

description.​esstring

Espanhol.

description.​frstring

Francês.

description.​hestring

Hebreu.

description.​itstring

Italiano.

description.​jastring

Japonês.

description.​kostring

Coreano.

description.​plstring

Polonês.

description.​ptstring

Português.

description.​rostring

Romeno.

description.​rustring

Russo.

description.​thstring

Tailandês.

description.​trstring

Turco.

description.​twstring

Chinês (Tradicional).

description.​vistring

Vietnamita.

expirationobject

Dados de término da assinatura.

expiration.​typestringobrigatório

Unidade de tempo. Pode ser day ou month.

Enum"day""month"
expiration.​valueinteger or nullobrigatório

Tempo de validade.

external_idstring

Planejar ID externo (32 caracteres).

grace_periodobject

Dados do período de carência.

grace_period.​typestringobrigatório

Unidade de tempo. Pode ser day.

Valor"day"
grace_period.​valueintegerobrigatório

Quantidade de unidades de tempo.

group_idstring

ID de grupo ao qual o plano está vinculado.

nameobject

Nome do plano. O valor consiste de pares "localization":"plan name".

name.​arstring

Árabe.

name.​bgstring

Búlgaro.

name.​cnstring

Chinês (Simplificado).

name.​csstring

Tcheco.

name.​destring

Alemão.

name.​enstring

Inglês.

name.​esstring

Espanhol.

name.​frstring

Francês.

name.​hestring

Hebreu.

name.​itstring

Italiano.

name.​jastring

Japonês.

name.​kostring

Coreano.

name.​plstring

Polonês.

name.​ptstring

Português.

name.​rostring

Romeno.

name.​rustring

Russo.

name.​thstring

Tailandês.

name.​trstring

Turco.

name.​twstring

Chinês (Tradicional).

name.​vistring

Vietnamita.

refund_periodinteger or null

Período em que o usuário pode reembolsar o pagamento de um plano de assinatura (em dias).

statusobject
status.​valuestring

Status do plano de assinatura.

Enum"active""disabled"
tagsArray of strings

Rótulos do plano.

trialobject

Dados do período de teste. Se o parâmetro não for passado, o valor padrão (0 dia) será usado.

trial.​typestringobrigatório

Unidade de tempo. Pode ser day.

Valor"day"
trial.​valueintegerobrigatório

Quantidade de unidades de tempo.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 20,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 17,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 2000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "3x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "tags": [],
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

Respostas

OK.

Corpoapplication/json
Resposta
application/json
{
  "billing_retry": {
    "value": 1
  },
  "charge": {
    "amount": 20,
    "currency": "USD",
    "period": { … },
    "prices": [ … ]
  },
  "description": {
    "en": "3x more experience!"
  },
  "expiration": {
    "type": "day",
    "value": 0
  },
  "external_id": "exp",
  "grace_period": {
    "type": "day",
    "value": 2
  },
  "group_id": null,
  "id": 241082,
  "localized_name": "Experience boost",
  "name": {
    "en": "Experience boost"
  },
  "project_id": 40797,
  "refund_period": null,
  "status": {
    "value": "active"
  },
  "tags": [],
  "trial": {
    "type": "day",
    "value": 7
  },
  "type": "all"
}

Produtos

Operações

Subscription management

Operações

Pagamentos

Operações

Promoções

Operações

Cupons

Operações

Subscription management

Operações