Pay an invoice

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": {
    "prePaymentCreditAmount": 123,
    "postPaymentCreditAmount": 123,
    "amount": 123,
    "company": {
      "billingAddress": "<string>",
      "businessAddress": {
        "city": "<string>",
        "countryCode": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "createDate": "2023-11-07T05:31:56Z",
      "credits": {
        "expiring": 123,
        "permanent": 123
      },
      "dayPasses": {
        "expiring": 123
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "legalName": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "notes": "<string>",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxId": "<string>",
      "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",
      "refund": {
        "amount": 123,
        "createDate": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "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"
  }
}

POST

invoices

{id}

pay

Pay an invoice

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": {
    "prePaymentCreditAmount": 123,
    "postPaymentCreditAmount": 123,
    "amount": 123,
    "company": {
      "billingAddress": "<string>",
      "businessAddress": {
        "city": "<string>",
        "countryCode": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "createDate": "2023-11-07T05:31:56Z",
      "credits": {
        "expiring": 123,
        "permanent": 123
      },
      "dayPasses": {
        "expiring": 123
      },
      "deleteDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "legalName": "<string>",
      "locationRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "notes": "<string>",
      "subscriptionRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "taxId": "<string>",
      "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",
      "refund": {
        "amount": 123,
        "createDate": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "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

Authorization

string

header

required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id

string<uuid>

The id of the network. Required when using bearer token authentication

Path Parameters

string<uuid>

required

The id of an invoice

Body

application/json

paymentMethod

object

required

Show child attributes

paymentMethod.type

enum<string>

required

Available options:

external

Response

transaction

object

Show child attributes

transaction.prePaymentCreditAmount

number<float>

transaction.postPaymentCreditAmount

number<float>

transaction.amount

number<float>

transaction.company

object

Show child attributes

transaction.company.billingAddress

string

transaction.company.businessAddress

object

Show child attributes

transaction.company.businessAddress.city

string

transaction.company.businessAddress.countryCode

string

transaction.company.businessAddress.line1

string

transaction.company.businessAddress.line2

string

transaction.company.businessAddress.postalCode

string

transaction.company.businessAddress.state

string

transaction.company.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.company.credits

object

Show child attributes

transaction.company.credits.expiring

number

transaction.company.credits.permanent

number

transaction.company.dayPasses

object

Show child attributes

transaction.company.dayPasses.expiring

number

transaction.company.deleteDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.company.id

string

transaction.company.legalName

string

transaction.company.locationRef

string<uuid>

transaction.company.metadata

object

Use to attach key-value data to the object. Available only for admins.

transaction.company.notes

string

transaction.company.subscriptionRef

string<uuid>

transaction.company.taxId

string

transaction.company.title

string

transaction.companyRef

string<uuid>

transaction.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.currencyCode

string

transaction.dueDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.id

string<uuid>

transaction.issueDate

string<date-time>

Datetime when invoice was made ready for payment.

transaction.items

object[]

Show child attributes

transaction.items.amount

number<float>

transaction.items.booking

object

Show child attributes

transaction.items.booking.id

string<uuid>

transaction.items.booking.resource

object

Show child attributes

transaction.items.booking.resource.id

string<uuid>

transaction.items.booking.resource.title

string

transaction.items.booking.resource.type

enum<string>

Available options:

dedicatedDesk,

hotDesk,

office,

parkingLot,

room

transaction.items.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.items.creditPackage

object

Show child attributes

transaction.items.creditPackage.amount

number

transaction.items.currencyCode

string

transaction.items.description

string

transaction.items.discountedAmount

number

transaction.items.discounts

object[]

Show child attributes

transaction.items.discounts.coupon

object

Show child attributes

transaction.items.discounts.coupon.amountOff

number

One of amountOff or percentOff must be present.

transaction.items.discounts.coupon.currencyCode

string

Currency code exists if amountOff is present.

transaction.items.discounts.coupon.percentOff

number

One of amountOff or percentOff must be present.

transaction.items.id

string<uuid>

transaction.items.invoiceRef

string<uuid>

transaction.items.netDiscountedAmount

number

transaction.items.netUnitAmount

number<float>

transaction.items.order

object

Show child attributes

transaction.items.order.id

string<uuid>

transaction.items.order.option

object

Show child attributes

transaction.items.order.option.id

string<uuid>

transaction.items.order.option.name

string

transaction.items.order.product

object

Show child attributes

transaction.items.order.product.id

string<uuid>

transaction.items.order.product.title

string

transaction.items.plan

object

Show child attributes

transaction.items.plan.id

string<uuid>

transaction.items.plan.title

string

transaction.items.quantity

number<integer>

transaction.items.tax

object

Show child attributes

transaction.items.tax.inclusive

boolean

transaction.items.tax.rate

number<float>

transaction.items.ticket

object

Show child attributes

transaction.items.ticket.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.items.ticket.id

string<uuid>

transaction.items.ticket.event

object

Show child attributes

transaction.items.ticket.event.endDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.items.ticket.event.id

string<uuid>

transaction.items.ticket.event.startDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.items.ticket.event.title

string

transaction.items.type

enum<string>

Available options:

booking,

creditPackage,

custom,

eventTicket,

order,

subscriptionItem

transaction.items.unitAmount

number<float>

transaction.locationRef

string<uuid>

transaction.membershipRef

string<uuid>

transaction.number

string

transaction.pdfUrl

string<uri>

transaction.status

enum<string>

Available options:

canceled,

draft,

failed,

issued,

paid,

pending,

processing,

succeeded,

voided

transaction.timezoneId

string

Timezone identifier for the location (e.g. 'Europe/Kyiv')

transaction.transaction

object

Show child attributes

transaction.transaction.amount

number<float>

transaction.transaction.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.transaction.id

string<uuid>

transaction.transaction.paymentMethod

object

Show child attributes

transaction.transaction.paymentMethod.id

string

transaction.transaction.paymentMethod.label

enum<string>

Available options:

American Express,

China UnionPay,

Diners Club,

Discover,

Japan Credit Bureau,

Mastercard,

Unknown,

Visa

transaction.transaction.paymentMethod.type

enum<string>

Available options:

external,

flow,

fondy,

freedompay,

kakaopay,

mercadopago,

paypal,

paystack,

plata,

stripe,

tap,

wayforpay

transaction.transaction.status

enum<string>

Available options:

canceled,

failed,

pending,

processing,

succeeded

transaction.transaction.refund

object

Show child attributes

transaction.transaction.refund.amount

number<float>

transaction.transaction.refund.createDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

transaction.transaction.refund.id

string<uuid>

transaction.user

object

Show child attributes

transaction.user.about

string

transaction.user.email

string

transaction.user.id

string<uuid>

transaction.user.name

string

transaction.user.phoneNumber

string

transaction.user.photoUrl

string

transaction.user.surname

string

transaction.voidDate

string<date-time>

The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z

Retrieve an invoice Create a invoice item

⌘I

Getting started

Endpoints

Pay an invoice

OAuth

Authorizations

Headers

Path Parameters

Body

Response