PApaylocity
Subscription

Upsert Subscription

Changed on

🚧 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
put/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/subscription

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentOrders/subscription
  • Auth
    none declared. Required headers: Authorization

Path parameters

companyIdstring required

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

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

levelstring nullable

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

pricenumber double nullable

The value of the subscription. Optional.

currencystring nullable

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

termstring nullable

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

expirationDatestring date-time nullable

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

Response

Created - Resource has been created.

levelstring nullable

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

pricenumber double nullable

The value of the subscription. Optional.

currencystring nullable

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

termstring nullable

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

expirationDatestring date-time nullable

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

Changes