Create subscription

post

https://partner-api.monta.com/api/v1/subscriptions

Required scope: subscriptions:write
Organization authorization: supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

planId

int64

> 0

Id of the plan to subscribe to

customerId

int64

> 0

Id of the customer the subscription is created for, e.g. team or charge-point id

customerType

string

enum

required

Type of the customer that the subscription is created for. e.g. team or charge-point

Allowed:

discountAbsolute

double | null

≥ 0

Allows to modify the absolute discount on a subscription if provided.
If not provided, the discount of the plan is used.
Note: If you want to set it on an existing subscription, you have to cancel the subscription first.

discountPercentage

double | null

≥ 0

Allows to modify the percentage discount on a subscription if provided.
If not provided, the discount of the plan is used.
Note: If you want to set it on an existing subscription, you have to cancel the subscription first.

serviceConfig

object | null

Configure the subscription, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.

userId

int64 | null

> 0

The user that should be assigned as the purchaser of the subscription. If not provided, the subscription will be assigned to the default user for this consumer.

nextPurchaseAt

date-time | null

Date when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Has to be a date in the future.

sendNotifications

boolean | null

Defaults to true

Whether to send the subscription-created notifications (e.g. confirmation email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS.

Responses

201The created subscription

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found