Create a new set of credits.

post

https://app.officernd.com/api/v2/organizations/{orgSlug}/credits

Required scopes: flex.space.credits.create

Path Params

orgSlug

string

required

organization slug

Body Params

Credits data to add.

count

number

required

The number of credits granted.

validFor

string

enum

The type of the credits and what they're valid for.

Allowed:

resourceTypes

array of strings

The resource types for which the credits are applied.

resourceTypes

company

string

The _id of the company with which the credits are associated.

member

string

The _id of the member with which the credits are associated.

resourceRates

array of strings

An array that contains the _ids of the resource rates for which the credits will be valid.
If left empty the credits will be valid for all rates.

resourceRates

intervalLength

string

enum

Determines the recurrence of the credits.
Can be either "month" or "once". If unspecified the set of credits issued will be set as "once".

Allowed:

startDate

string

The start date of the monthly recurring credits. Should be used only for credits with "intervalLength" set to "month".

endDate

string

The end date of the monthly recurring credits. Should be used only for credits with "intervalLength" set to "month".

Response

201