Overview
Subscription endpoint allows partner to submit details about the customer’s subscription details. It will include level, price, expiration date and list of billing codes. Although including subscription details is not required, it is best practice to provide to help troubleshooting on the Paylocity side, i.e. subscription expired and that is why customer is no longer able to order an assessment.
Both endpoints need to respond within 20 seconds with an HTTP status indicating the success (200) or failure (4xx or 5xx).
There could be only one subscription per company, therefore we don’t need an id here. PUT method will be supported, which means that it will be either created or updated.
| Property | Type | Required/Optional | Description |
|---|---|---|---|
| level | string Max length = 36 | Optional | This is the level of the clients subscription. For example: premium, basic, etc. |
| price | Number | Optional | The value of the subscription. |
| currency | String Possible values: USD, EUR, GBP, CAD | Optional | The currency of the price. |
| term | String Max length = 36 | Optional | The term of the clients subscription. For example: monthly, quarterly, annually. |
| expirationDate | String ISO 8601 format in UTC | Optional | The date the subscription will expire. |
| billingCodes | Array | Optional | Array of billing codes. |
| billingCodes.Code | String Max length = 36 | Optional | This is the Billing code created on your side that apply to the client specifically for invoicing purposes. |
| billingCodes.isActive | Boolean | Optional | This is the optional field to make a billing code active or inactive. If it is active it will show in the UI for users to select for a specific job. Inactive will not show in the UI. |