Upsert Subscription

🚧

Partner Restricted

All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement.
Please reach out to our team 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
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.

Subscription payload.

string | null

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

double | null

The value of the subscription.
Optional.

string | null

The currency code (USD, EUR, GBP, CAD...).
Optional.

string | null

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

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
boolean

If true all responses are mocked and generated randomly.

string
required

Authorization token. Ex. Bearer ...

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

204

No Content - Resource has been updated.

Language
LoadingLoading…
Response
Choose an example:
application/json