Abo-Modell erstellen

post/projects/{project_id}/subscriptions/plans

Legt ein Abo-Modell an.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Projekt-ID.

Request Body schema: application/json

required

object

Bezeichnung des Abo-Modells. Besteht aus Paaren vom Typ "localization":"plan name" (Sprache:Bezeichnung des Abo-Modells).

ar	string Arabisch.
bg	string Bulgarisch.
cn	string Chinesisch (vereinfacht).
cs	string Tschechisch.
de	string Deutsch.
en	string Englisch.
es	string Spanisch.
fr	string Französisch.
he	string Hebräisch.
it	string Italienisch.
ja	string Japanisch.
ko	string Koreanisch.
pl	string Polnisch.
pt	string Portugiesisch.
ro	string Rumänisch.
ru	string Russisch.
th	string Thai.
tr	string Türkisch.
tw	string Chinesisch (traditionell).
vi	string Vietnamesisch.

required

object

Details zur Abrechnung.

required

object

Abrechnungszeitraum.

value required	integer Anzahl der Zeiteinheiten. Der Wert hängt vom Parametertyp ab, möglich sind: - von 1 bis 366, sofern für `type` `day` festgelegt ist - von 1 bis 12, sofern für `type` `month` festgelegt ist -0, sofern für `type` `lifetime` festgelegt ist
type required	string Zeiteinheit. Möglich sind `day`, `month` oder `lifetime`. Enum: "day" "month" "lifetime"

amount

number <float>

Abrechnungsbetrag.

currency

string

Kaufwährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.

Array of objects

Liste der Preise in verschiedenen Währungen.

Array

amount required	number <float> Abrechnungsbetrag.
currency required	string Kaufwährung. Währungscode, bestehend aus drei Buchstaben gemäß ISO 4217.
setup_fee	number <float> Einmalige Einrichtungsgebühr, die als Teil der ersten Rechnung berechnet wird.

object

Details zu erneuten Abrechnungsversuchen.

value

required

integer

Anzahl der erneuten Abrechnungsversuche.

object

Beschreibung zum Abo-Modell. Besteht aus Paaren vom Typ "localization":"plan description" (Sprache:Beschreibung zum Abo-Modell).

ar	string Arabisch.
bg	string Bulgarisch.
cn	string Chinesisch (vereinfacht).
cs	string Tschechisch.
de	string Deutsch.
en	string Englisch.
es	string Spanisch.
fr	string Französisch.
he	string Hebräisch.
it	string Italienisch.
ja	string Japanisch.
ko	string Koreanisch.
pl	string Polnisch.
pt	string Portugiesisch.
ro	string Rumänisch.
ru	string Russisch.
th	string Thai.
tr	string Türkisch.
tw	string Chinesisch (traditionell).
vi	string Vietnamesisch.

object

Details zum Auslaufen des Abonnements.

value required	integer Zeitliche Gültigkeit.
type required	string Zeiteinheit. Möglich sind `day` oder `month`. Enum: "day" "month"

external_id

string

Externe ID des Abo-Modells (32 Zeichen).

object

Angaben zur Übergangsfrist.

value required	integer Anzahl der Zeiteinheiten.
type required	string Zeiteinheit. Möglich sind `day`. Value: "day"

group_id

string

Gruppen-ID, mit der das Abo-Modell verknüpft ist.

integer

ID des Abo-Modells.

refund_period

integer

Zeitraum, in dem der Nutzer die Zahlung für ein Abo-Modell erstattet bekommen kann (in Tagen).

object

value

string

Status des Abo-Modells.

Enum: "active" "disabled"

tags

Array of strings

Abo-Modell-Markierungen.

object

Details zum Probezeitraum.

value required	integer Anzahl der Zeiteinheiten.
type required	string Zeiteinheit. Möglich sind `day`. Value: "day"

Responses

201

Erstellt.

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
}