paymentSchedules

Get a payment schedule by ID or reference

Requires the PAYMENT_SCHEDULE.VIEW permission.

get/v{version}/payment-schedules/{resourceIdOrReference}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/payment-schedules/{resourceIdOrReference}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdOrReferencestring required

The ID or reference of the resource.

Query parameters

expand[]string[]

The id fields of the resources that are going to be expanded.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
created_atstring nullable
updated_atstring nullable
status'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'DONE'
customer_idstring

Resource ID of type CUSTOMER

referencestring
descriptionstring nullable
statement_descriptorstring nullable
payment_method_idstring

Resource ID of type PAYMENT_METHOD

billing_entity_idstring

Resource ID of type BILLING_ENTITY

type'INSTALLMENTS' | 'ONE_OFF' | 'RECURRING'

Changes

No recorded changes to this operation across all 1 revision of this API.