API Reference

Update customer contract

patch
https://api.phonelineplus.com/v2/customers//contract

Updates contract term or plan asynchronously; returns a jobID. Send either term (optionally with renew: true) or plan, not both. To change plan and term, call this endpoint twice and track both jobIDs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The ID of the customer

Body Params
number
enum

Contract length in months. Mutually exclusive with plan in the same request.

Allowed:
string
enum

Plan type. Mutually exclusive with term in the same request.

Allowed:
boolean

When true together with term, renews the contract instead of extending. Not used with plan.

Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?