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

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.

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

ID de grupo ao qual o plano está vinculado.

nameobject

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

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. Se o parâmetro não for passado, o valor padrão (0 dia) será usado.

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"
}

Excluir Plano

Pedido

Exclui 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}/delete'

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