Saltar para o conteúdo
/
Criar 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

Obter Planos

Pedido

Lista todos os planos de assinaturas.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

Consulta
plan_idinteger

ID de plano de assinatura.

limitintegerobrigatório

Limite da quantidade de elementos na página.

offsetinteger

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

external_idstring

Planejar ID externo (32 caracteres).

group_idstring

ID de grupo aos quais os planos estão vinculados.

product_idinteger

ID de produto aos quais os planos estão vinculados.

querystring

Consultar (procura em name.en (local padrão)).

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/subscriptions/projects/{project_id}/subscriptions/plans?plan_id=0&limit=0&offset=0&external_id=string&group_id=string&product_id=0&query=string'

Respostas

OK.

Corpoapplication/jsonArray [
billing_retryobject

Dados de tentativa de cobrança.

chargeobject

Dados de cobrança.

descriptionobject

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

expirationobject

Dados de término da assinatura.

external_idstring

Planejar ID externo (32 caracteres).

grace_periodobject

Dados do período de carência.

group_idstring or null

ID de grupo ao qual o plano está vinculado.

idinteger

ID de plano de assinatura.

nameobject

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

project_idinteger

ID de projeto.

refund_periodinteger or null

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

statusobject
tagsArray of strings

Rótulos do plano.

trialobject

Dados do período de teste.

localized_namestring

Nome do plano no idioma padrão (en), replica o valor name.en.

]
Resposta
application/json
[
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "3b355320",
    "grace_period": { … },
    "group_id": null,
    "id": 241037,
    "localized_name": "Platinum VIP",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  },
  {
    "billing_retry": { … },
    "charge": { … },
    "description": { … },
    "expiration": { … },
    "external_id": "0fe1b6fc",
    "grace_period": { … },
    "group_id": null,
    "id": 241038,
    "localized_name": "Gold Status",
    "name": { … },
    "project_id": 40797,
    "refund_period": null,
    "status": { … },
    "tags": [],
    "trial": { … }
  }
]

Criar Plano

Pedido

Crie um plano de assinatura.

Segurança
basicAuth
Caminho
project_idintegerobrigatório

ID de projeto.

Corpoapplication/jsonobrigatório
billing_retryobject

Dados de tentativa de cobrança.

chargeobjectobrigatório

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.

descriptionobject

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

expirationobject

Dados de término da assinatura.

external_idstring

Planejar ID externo (32 caracteres).

grace_periodobject

Dados do período de carência.

group_idstring or null

ID de grupo ao qual o plano está vinculado.

idinteger

ID de plano de assinatura.

nameobjectobrigatório

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.

project_idinteger

ID de projeto.

refund_periodinteger or null

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

statusobject
tagsArray of strings

Rótulos do plano.

trialobject

Dados do período de teste.

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

Respostas

Criado.

Corpoapplication/json
external_idstring
plan_idinteger
Resposta
application/json
{
  "external_id": "exp",
  "plan_id": 241082
}

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.

Produtos

Operações

Subscription management

Operações

Pagamentos

Operações

Promoções

Operações

Cupons

Operações

Subscription management

Operações