Créer un plan

Créer un planServer-sideAdmin

post/projects/{project_id}/subscriptions/plans

Crée un plan d'abonnement.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID de projet.

Request Body schema: application/json

required

object

Nom du plan. La valeur est constituée de paires "localization":"plan name".

ar	string Arabe.
bg	string Bulgare.
cn	string Chinois (simplifié).
cs	string Tchèque.
de	string Allemand.
en	string Anglais.
es	string Espagnol.
fr	string Français.
he	string Hébreu.
it	string Italien.
ja	string Japonais.
ko	string Coréen.
pl	string Polonais.
pt	string Portugais.
ro	string Roumain.
ru	string Russe.
th	string Thaïlandais.
tr	string Turc.
tw	string Chinois (traditionnel).
vi	string Vietnamien.

required

object

Informations de facturation.

required

object

Période de facturation.

value required	integer Nombre d'unités de temps. La valeur dépend du paramètre type et peut être : - de 1 à 366, si `type` est défini sur `day` ; - de 1 à 12, si `type` est défini sur `month` ; - 0 si `type` est défini sur `lifetime`.
type required	string Unité de temps. La valeur peut être `day`, `month` ou `lifetime`. Enum: "day" "month" "lifetime"

amount

number <float>

Montant de facturation.

currency

string

Devise d'achat. Code de devise à trois lettres selon la norme ISO 4217.

Array of objects

Liste des prix dans différentes devises.

Array

amount required	number <float> Montant de facturation.
currency required	string Devise d'achat. Code de devise à trois lettres selon la norme ISO 4217.
setup_fee	number <float> Frais de mise en service uniques facturés dans le cadre de la première facture.

object

Informations sur la relance de la facturation.

value

required

integer

Nombre de relances de facturation.

object

Description du plan. La valeur est constituée de paires "localization":"plan description".

ar	string Arabe.
bg	string Bulgare.
cn	string Chinois (simplifié).
cs	string Tchèque.
de	string Allemand.
en	string Anglais.
es	string Espagnol.
fr	string Français.
he	string Hébreu.
it	string Italien.
ja	string Japonais.
ko	string Coréen.
pl	string Polonais.
pt	string Portugais.
ro	string Roumain.
ru	string Russe.
th	string Thaïlandais.
tr	string Turc.
tw	string Chinois (traditionnel).
vi	string Vietnamien.

object

Informations sur l'expiration de l'abonnement.

value required	integer Durée de validité.
type required	string Unité de temps. La valeur peut être `day` ou `month`. Enum: "day" "month"

external_id

string

ID externe du plan (32 caractères).

object

Informations sur le délai de grâce.

value required	integer Nombre d'unités de temps.
type required	string Unité de temps. L'unique valeur possible est `day`. Value: "day"

group_id

string

ID du groupe auquel le plan est lié.

integer

ID de plan d'abonnement.

project_id

integer

ID de projet.

refund_period

integer

Période durant laquelle l'utilisateur peut se faire rembourser le paiement d'un abonnement (en jours).

object

value

string

Statut de plan d'abonnement.

Enum: "active" "disabled"

tags

Array of strings

Balises du plan.

object

Informations sur la période d'essai.

value required	integer Nombre d'unités de temps.
type required	string Unité de temps. L'unique valeur possible est `day`. Value: "day"

Responses

201

Сreated.

Request samples

application/json

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

Response samples

application/json

{"external_id": "exp",
"plan_id": 241082
}