Getting started
Endpoints
- Benefit applications
- Benefits
- Bookings
- Companies
- Events
- Event tickets
- Feed posts
- Invoices
- Invoice items
- Locations
- Memberships
- Networks
- Orders
- Plans
- Products
- Resources
- Subscriptions
- Support tickets
- Transactions
- Visitors
Invoices
Pay an invoice
Mark an invoice as paid by External Payment
.
OAuth
Required scopes:invoices
POST
/
invoices
/
v1
/
{id}
/
pay
curl --request POST \
--url https://api.spacebring.com/invoices/v1/{id}/pay \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"paymentMethod": {
"type": "external"
}
}'
{
"transaction": {
"amount": 123,
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issueDate": "2023-11-07T05:31:56Z",
"items": [
{
"amount": 123,
"booking": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "dedicatedDesk"
}
},
"createDate": "2023-11-07T05:31:56Z",
"creditPackage": {
"amount": 123
},
"currencyCode": "<string>",
"description": "<string>",
"discountedAmount": 123,
"discounts": [
{
"coupon": {
"amountOff": 123,
"currencyCode": "<string>",
"percentOff": 123
}
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netDiscountedAmount": 123,
"netUnitAmount": 123,
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"quantity": 123,
"tax": {
"inclusive": true,
"rate": 123
},
"ticket": {
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "2023-11-07T05:31:56Z",
"title": "<string>"
}
},
"type": "booking",
"unitAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"pdfUrl": "<string>",
"status": "canceled",
"timezoneId": "<string>",
"transaction": {
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": {
"id": "<string>",
"label": "American Express",
"type": "external"
},
"status": "canceled"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"voidDate": "2023-11-07T05:31:56Z"
}
}
Authorizations
See our authentication documentation for how to authorize your requests
Headers
The id of the network. Required when using bearer token authentication
Path Parameters
The id of an invoice
Body
application/json
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.spacebring.com/invoices/v1/{id}/pay \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"paymentMethod": {
"type": "external"
}
}'
{
"transaction": {
"amount": 123,
"company": {
"createDate": "<string>",
"id": "<string>",
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"notes": "<string>",
"subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"companyRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createDate": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issueDate": "2023-11-07T05:31:56Z",
"items": [
{
"amount": 123,
"booking": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"type": "dedicatedDesk"
}
},
"createDate": "2023-11-07T05:31:56Z",
"creditPackage": {
"amount": 123
},
"currencyCode": "<string>",
"description": "<string>",
"discountedAmount": 123,
"discounts": [
{
"coupon": {
"amountOff": 123,
"currencyCode": "<string>",
"percentOff": 123
}
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invoiceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"netDiscountedAmount": 123,
"netUnitAmount": 123,
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"option": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"quantity": 123,
"tax": {
"inclusive": true,
"rate": 123
},
"ticket": {
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": {
"endDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"startDate": "2023-11-07T05:31:56Z",
"title": "<string>"
}
},
"type": "booking",
"unitAmount": 123
}
],
"locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"pdfUrl": "<string>",
"status": "canceled",
"timezoneId": "<string>",
"transaction": {
"amount": 123,
"createDate": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"paymentMethod": {
"id": "<string>",
"label": "American Express",
"type": "external"
},
"status": "canceled"
},
"user": {
"about": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phoneNumber": "<string>",
"photoUrl": "<string>",
"surname": "<string>"
},
"voidDate": "2023-11-07T05:31:56Z"
}
}