The Process Subscription object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

posting_date string required
subscription string
The Process Subscription object 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}
GET /api/accounts/process-subscription/{id}

Retrieve a process subscription

Retrieves the details of an existing process subscription. Supply the unique process subscription ID that was returned from a previous request.

Path parameters

id string required

The identifier of the process subscription to retrieve.

Returns

Returns the process subscription object if a valid identifier was provided.

GET /api/accounts/process-subscription/{id} 
curl https://api.overplane.dev/api/accounts/process-subscription/process-subscription_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}
GET /api/accounts/process-subscription

List all process subscriptions

Returns a list of process subscriptions. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of process subscription objects.

GET /api/accounts/process-subscription 
curl https://api.overplane.dev/api/accounts/process-subscription \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "process-subscription_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "posting_date": "2024-01-15",
      "subscription": "subscription_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/process-subscription

Create a process subscription

Creates a new process subscription object.

Body parameters

status string

Default: draft

posting_date string required
subscription string

Returns

Returns the newly created process subscription object if the call succeeded.

POST /api/accounts/process-subscription 
curl https://api.overplane.dev/api/accounts/process-subscription \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"posting_date":"2024-01-15"}'
Response 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}
PATCH /api/accounts/process-subscription/{id}

Update a process subscription

Updates the specified process subscription by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the process subscription to update.

Body parameters

status string

Default: draft

posting_date string
subscription string

Returns

Returns the updated process subscription object.

PATCH /api/accounts/process-subscription/{id} 
curl https://api.overplane.dev/api/accounts/process-subscription/process-subscription_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","posting_date":"2024-01-15"}'
Response 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}
DELETE /api/accounts/process-subscription/{id}

Delete a process subscription

Permanently deletes a process subscription. This cannot be undone.

Path parameters

id string required

The identifier of the process subscription to delete.

Returns

Returns a confirmation that the process subscription has been deleted.

DELETE /api/accounts/process-subscription/{id} 
curl https://api.overplane.dev/api/accounts/process-subscription/process-subscription_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "process-subscription_abc123",
  "deleted": true
}
POST /api/accounts/process-subscription/{id}/submit

Submit a process subscription

Submits a draft process subscription, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the process subscription to act on.

Returns

Returns the process subscription object with updated status.

POST /api/accounts/process-subscription/{id}/submit 
curl https://api.overplane.dev/api/accounts/process-subscription/process-subscription_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}
POST /api/accounts/process-subscription/{id}/cancel

Cancel a process subscription

Cancels a submitted process subscription, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the process subscription to act on.

Returns

Returns the process subscription object with updated status.

POST /api/accounts/process-subscription/{id}/cancel 
curl https://api.overplane.dev/api/accounts/process-subscription/process-subscription_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "process-subscription_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "subscription": "subscription_example"
}