Get
/CreateSubscription
Allows you to create a subscription assignment.
Security
API Key: api_key
Header parameter nameapi_key
Query parameters
externalId
string
The exernal ID of the subscription, usually a unique identifier from the calling system
clubId
stringRequired
The Id of the related subscription profile
userId
stringRequired
The Id of the related user
starts
stringRequired
When the subscription starts (in Unix epoch time)
expires
string
When the subscription expires (in Unix epoch time)
targetCompletion
string
When the subscription is expected to be completed by the student (in Unix epoch time)
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
ClubMembershipId
integer (int32)
The ID of the created subscription.
Example45632