Process Invoice Payment

POST

companies

{company_id}

invoices

{uuid}

process_payment

Process Invoice Payment

curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  }
}
'

import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment"

payload = { "amount": {
        "currency": "<string>",
        "value_in_cents": 123
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: {currency: '<string>', value_in_cents: 123}})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => [
        'currency' => '<string>',
        'value_in_cents' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment"

	payload := strings.NewReader("{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "auto_charges": true,
  "billed_customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "US",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "company_id": "<string>",
    "computed_entitlements": [
      {
        "entitlement_id": "<string>",
        "id": "<string>",
        "inherited_from_id": "<string>",
        "inherited_from_type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "original_value": "<unknown>",
        "overridden": true,
        "type": "<string>",
        "value": "<unknown>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "customer_integration_metadata": {},
    "display_name": "<string>",
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<string>",
    "parent_customer_id": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "billed_customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "US",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "company_id": "<string>",
    "computed_entitlements": [
      {
        "entitlement_id": "<string>",
        "id": "<string>",
        "inherited_from_id": "<string>",
        "inherited_from_type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "original_value": "<unknown>",
        "overridden": true,
        "type": "<string>",
        "value": "<unknown>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "customer_integration_metadata": {},
    "display_name": "<string>",
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<string>",
    "parent_customer_id": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "customer_id": "<string>",
  "due": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "due_date": "2023-11-07T05:31:56Z",
  "hosted_link": "<string>",
  "invoice_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "number": "<string>",
  "paid": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "paid_date": "2023-11-07T05:31:56Z",
  "pdf_link": "<string>",
  "prorated_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "refunded_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "revenue": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "status": "<string>",
  "sub_total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "subscription_id": "<string>",
  "total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id

string

required

The company ID with the prefix 'cmp_'.

uuid

string

required

The resource UUID

Body

application/json

amount

object

The amount to charge; defaults to the invoice's due amount

Show child attributes

Response

200 - application/json

auto_charges

boolean

Whether the invoice is automatically charged to the payment method on file for the customer

billed_customer

object

The expanded billed customer details for the invoice

Show child attributes

billed_customer_id

string

The billed customer ID for the invoice. This matches the customer_id by default, but can be set to another parent customer ID

created_at

string<date-time>

The date the invoice was created

currency

string

The currency of the invoice

customer

object

The expanded customer details for the invoice

Show child attributes

customer_id

string

The customer ID for the invoice

due

object

The total amount due on the invoice after any payments

Show child attributes

due_date

string<date-time>

The date the invoice total is due

hosted_link

null | string

The hosted link for the invoice. Includes a 1-day authentication token in the URL query parameter.

invoice_date

string<date-time>

The date for the invoice

name

string

The name of the invoice

number

string

The invoice number for the invoice

paid

object

The total amount paid against the invoice

Show child attributes

paid_date

null | string<date-time>

The date the invoice was paid

pdf_link

null | string

The PDF link for the invoice. Includes a 1-day authentication token in the URL query parameter.

prorated_amount

object

Any prorated amounts for the invoice

Show child attributes

refunded_amount

object

The total amount refunded against the invoice

Show child attributes

revenue

object

The revenue amount of the invoice (total minus credits)

Show child attributes

status

string

The status of the invoice such as PAID, DRAFT, VOID or PENDING

sub_total

object

The subtotal of the invoice which is prior to applying credits

Show child attributes

subscription_id

null | string

The subscription ID for the invoice, if is not a one-time invoice

total

object

The final total of the invoice after applying all credits, discounts and taxes

Show child attributes

updated_at

string<date-time>

The last date the invoice was updated

uuid

string

The unique identifier for the invoice

Process Invoice Payment

curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "currency": "<string>",
    "value_in_cents": 123
  }
}
'

import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment"

payload = { "amount": {
        "currency": "<string>",
        "value_in_cents": 123
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: {currency: '<string>', value_in_cents: 123}})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => [
        'currency' => '<string>',
        'value_in_cents' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment"

	payload := strings.NewReader("{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/invoices/{uuid}/process_payment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": {\n    \"currency\": \"<string>\",\n    \"value_in_cents\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "auto_charges": true,
  "billed_customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "US",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "company_id": "<string>",
    "computed_entitlements": [
      {
        "entitlement_id": "<string>",
        "id": "<string>",
        "inherited_from_id": "<string>",
        "inherited_from_type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "original_value": "<unknown>",
        "overridden": true,
        "type": "<string>",
        "value": "<unknown>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "customer_integration_metadata": {},
    "display_name": "<string>",
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<string>",
    "parent_customer_id": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "billed_customer_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer": {
    "address": {
      "address_line_1": "<string>",
      "address_line_2": "<string>",
      "city": "<string>",
      "country": "US",
      "place_id": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "arr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "billing_emails": [
      "<string>"
    ],
    "company_id": "<string>",
    "computed_entitlements": [
      {
        "entitlement_id": "<string>",
        "id": "<string>",
        "inherited_from_id": "<string>",
        "inherited_from_type": "<string>",
        "key": "<string>",
        "name": "<string>",
        "original_value": "<unknown>",
        "overridden": true,
        "type": "<string>",
        "value": "<unknown>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "customer_integration_metadata": {},
    "display_name": "<string>",
    "email": "<string>",
    "exclude_from_metrics": true,
    "id": "<string>",
    "identifier": "<string>",
    "integration_references": [
      {
        "integration_icon": "<string>",
        "integration_id": "<string>",
        "integration_key": "<string>",
        "integration_name": "<string>",
        "reference_type": "<string>",
        "remote_id": "<string>",
        "remote_type": "<string>"
      }
    ],
    "locale": "<string>",
    "managed_externally": true,
    "metadata": {},
    "mrr": {
      "currency": "<string>",
      "value_in_cents": 123
    },
    "name": "<string>",
    "org_name": "<string>",
    "owner_id": "<string>",
    "parent_customer_id": "<string>",
    "phone": "<string>",
    "status": "<string>",
    "title": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "customer_id": "<string>",
  "due": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "due_date": "2023-11-07T05:31:56Z",
  "hosted_link": "<string>",
  "invoice_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "number": "<string>",
  "paid": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "paid_date": "2023-11-07T05:31:56Z",
  "pdf_link": "<string>",
  "prorated_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "refunded_amount": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "revenue": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "status": "<string>",
  "sub_total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "subscription_id": "<string>",
  "total": {
    "currency": "<string>",
    "value_in_cents": 123
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

API Features

API Reference

Webhook Reference

Authorizations

Headers

Path Parameters

Body

Response