Update or create a subscription

put https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/subscription

🚧
Partner Restricted
All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to Techpartnerships@paylocity.com if you would like to discuss partnership opportunities.

Summary Description

This endpoint is used for updating or creating a subscription for a company within Paylocity's platform by the companyId.

Use Cases

Single Subscription Per Company: Each company can have only one subscription, eliminating the need for an ID in the request
Create or Update: The Partner can use this endpoint to either create a new subscription or update an existing one
Mandatory Subscription Object: Orders cannot be submitted without a subscription object, subject to confirmation with the partner

Path Params

companyId

string

required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.
Allowable Values:
9 char max.

Body Params

The subscription details to be updated or created.

level

string | null

The level of the client's subscription (e.g., premium, basic, etc.).
Max length = 36. Optional.

price

double | null

The value of the subscription.
Optional.

currency

string | null

The currency of the price (possible values: USD, EUR, GBP, CAD).
Optional.

term

string | null

The term of the client's subscription (e.g., monthly, quarterly, annually).
Max length = 36. Optional.

expirationDate

date-time | null

The date the subscription will expire (in UTC).
Optional.

billingCodes

array of objects | null

An array of billing codes.
Optional.

billingCodes

Headers

testMode

boolean

If true all responses are mocked and generated randomly.

Authorization

string

Authorization token. Ex. Bearer ...

Responses

204

No Content - Resource has been updated.

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/companyId/assessmentOrders/subscription \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'


xxxxxxxxxx
15
 
1
{
2
  "level": "string",
3
  "price": 0,
4
  "currency": "string",
5
  "term": "string",
6
  "expirationDate": "2025-04-06T12:58:23.903Z",
7
  "billingCodes": [
8
    {
9
      "code": "string",
10
      "isActive": true,
11
      "additionalProp": {}
12
    }
13
  ],
14
  "additionalProp": {}
15
}

201Created - Resource has been created.

400Bad Request - Returns the details of the error.

415Unsupported Media Type - Returns the details of the error.