Get additional costs for subscription

get https://api.reepay.com/v1/additional_cost/subscription/{handle}

Get all additional costs for subscription.

Responses

Response body

array of objects

object

invoice

string

Invoice id for the invoice the additional cost has been assigned to once it has been transferred

state

string

required

State of the additional cost, one of the following: pending, transferred, cancelled. A pending additonal cost has not yet been transferred to a invoice. Cancelled addtional costs have been cancelled manually.

pending transferred cancelled

subscription

string

required

length ≥ 1

Subscription handle

handle

string

required

length ≥ 1

Per account unique handle for the additional cost

ordertext

string

required

length ≥ 1

Order text for the additional cost. Will be on affected invoices.

quantity

int32

≥ 1

Quantity for the additional cost. Default 1.

amount

int32

required

≥ 0

Additional cost total amount

vat

float

Optional vat for additional cost. Account default is used if none given.

created

date-time

required

Date when the additional cost was created. In ISO-8601 extended offset date-time format.

amount_incl_vat

boolean

required

Whether the amount is including VAT. Default true.

amount_vat

int32

required

Additional cost vat amount

amount_ex_vat

int32

required

Additional cost amount without vat

tax_policy

string

Optional tax policy handle for this additional cost. If vat and tax policy is given, vat will be ignored.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.reepay.com/v1/additional_cost/subscription/handle \
3
     --header 'accept: application/json'


xxxxxxxxxx
17
 
1
[
2
  {
3
    "invoice": "1f71771bfbfc40eabf6df4cc2e31d853",
4
    "state": "pending",
5
    "subscription": "sub000219",
6
    "handle": "cost032",
7
    "ordertext": "Yoga mat",
8
    "quantity": 1,
9
    "amount": 10000,
10
    "vat": 0.25,
11
    "created": "2015-04-04T12:40:56.656Z",
12
    "amount_incl_vat": true,
13
    "amount_vat": 2000,
14
    "amount_ex_vat": 8000,
15
    "tax_policy": "default_tax_policy_handle"
16
  }
17
]

200Successful operation

400Invalid request, see error codes at https://api.reepay.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.reepay.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii