Create Checkout Link

POST

checkout-links

curl --request POST \
  --url https://api.getruba.com/v1/checkout-links/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_processor": "<string>",
  "product_price_id": "<string>",
  "metadata": {},
  "trial_interval_count": 500,
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": false,
  "discount_id": "<string>",
  "seats": 5000,
  "success_url": "<string>",
  "return_url": "<string>"
}
'

import requests

url = "https://api.getruba.com/v1/checkout-links/"

payload = {
    "payment_processor": "<string>",
    "product_price_id": "<string>",
    "metadata": {},
    "trial_interval_count": 500,
    "label": "<string>",
    "allow_discount_codes": True,
    "require_billing_address": False,
    "discount_id": "<string>",
    "seats": 5000,
    "success_url": "<string>",
    "return_url": "<string>"
}
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({
    payment_processor: '<string>',
    product_price_id: '<string>',
    metadata: {},
    trial_interval_count: 500,
    label: '<string>',
    allow_discount_codes: true,
    require_billing_address: false,
    discount_id: '<string>',
    seats: 5000,
    success_url: '<string>',
    return_url: '<string>'
  })
};

fetch('https://api.getruba.com/v1/checkout-links/', 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.getruba.com/v1/checkout-links/",
  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([
    'payment_processor' => '<string>',
    'product_price_id' => '<string>',
    'metadata' => [
        
    ],
    'trial_interval_count' => 500,
    'label' => '<string>',
    'allow_discount_codes' => true,
    'require_billing_address' => false,
    'discount_id' => '<string>',
    'seats' => 5000,
    'success_url' => '<string>',
    'return_url' => '<string>'
  ]),
  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.getruba.com/v1/checkout-links/"

	payload := strings.NewReader("{\n  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\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.getruba.com/v1/checkout-links/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/checkout-links/")

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  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "client_secret": "<string>",
  "success_url": "<string>",
  "return_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "seats": 123,
  "organization_id": "<string>",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "amount_type": "<string>",
          "price_currency": "<string>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "selectable": true,
          "deletable": true,
          "is_deleted": true,
          "organization_id": "<string>"
        }
      ],
      "medias": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "name": "<string>",
          "path": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "storage_version": "<string>",
          "checksum_etag": "<string>",
          "checksum_sha256_base64": "<string>",
          "checksum_sha256_hex": "<string>",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "version": "<string>",
          "service": "<string>",
          "is_uploaded": true,
          "created_at": "2023-11-07T05:31:56Z",
          "size_readable": "<string>",
          "public_url": "<string>"
        }
      ]
    }
  ],
  "discount": {
    "amount": 123,
    "currency": "<string>",
    "amounts": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "max_redemptions": 123,
    "redemptions_count": 123,
    "organization_id": "<string>"
  },
  "url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Trying to spin up a one-time checkout session? Checkout Links are likely not the right fit.Checkout Links are reusable URLs that produce a checkout session the moment they are opened. They work well when you want to kick off a purchase from a website or social post.When you need to launch a checkout for a user inside your own product, reach for the Checkout Sessions API instead.

Authorizations

Authorization

string

header

required

Authentication: You can generate a Personal Access Token from your settings.

Body

application/json

CheckoutLinkCreateProductPrice
CheckoutLinkCreateProduct
CheckoutLinkCreateProducts

Schema to create a new checkout link from a a single product price.

Deprecated: Use CheckoutLinkCreateProducts instead.

payment_processor

string

required

Payment Processor: Payment processor to use. Currently only Stripe is supported.

Allowed value: "stripe"

product_price_id

string<uuid4>

required

metadata

Metadata · object

Metadata map for information your integration needs to retain.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

trial_interval

enum<string> | null

Unit used to measure the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

Length of the trial measured in the selected interval.

Required range: 1 <= x <= 1000

label

string | null

Label: Optional label to distinguish links internally.

allow_discount_codes

boolean

default:true

Indicates whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.

require_billing_address

boolean

default:false

Indicates whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.

discount_id

string<uuid4> | null

Identifier of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.

seats

integer | null

Seats: Seat quantity locked into this checkout link. Every linked product must support seat pricing and accept the specified quantity. Ruba ignores the value if a product's configuration no longer supports it when checkout begins.

Required range: 1 <= x <= 10000

success_url

string<uri> | null

Success Url: URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID} query parameter to retrieve the checkout session id.

Required string length: 1 - 2083

return_url

string<uri> | null

If provided, a back button will be shown in the checkout to return to this URL.

Required string length: 1 - 2083

Response

Response: Checkout link created.

Checkout link data.

string<uuid4>

required

The stable identifier for this record.

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

trial_interval

enum<string> | null

required

Unit used to measure the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

required

Length of the trial measured in the selected interval.

metadata

object

required

Show child attributes

payment_processor

enum<string>

required

Payment Processor: Payment processor used.

Available options:

stripe

client_secret

string

required

Client Secret: Client secret used to access the checkout link.

success_url

string | null

required

Success Url: URL where the customer will be redirected after a successful payment.

return_url

string | null

required

If provided, a back button will be shown in the checkout to return to this URL.

label

string | null

required

Label: Optional label to distinguish links internally.

allow_discount_codes

boolean

required

Indicates whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.

require_billing_address

boolean

required

discount_id

string<uuid4> | null

required

Identifier of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.

seats

integer | null

required

organization_id

string<uuid4>

required

Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

products

CheckoutLinkProduct · object[]

required

Show child attributes

discount

DiscountFixedOnceForeverDurationBase · object

required

DiscountFixedOnceForeverDurationBase
DiscountFixedRepeatDurationBase
DiscountPercentageOnceForeverDurationBase
DiscountPercentageRepeatDurationBase

Show child attributes

url

string

required

read-only

Change Checkout Link### Intent Applies the supplied changes to the checkout link. ### When to call it Call this when the checkout link already exists and its stored values need to change. ### Access boundary Authorize the request with a token that carries `checkout_links:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives.

⌘I

Create Checkout Link

curl --request POST \
  --url https://api.getruba.com/v1/checkout-links/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_processor": "<string>",
  "product_price_id": "<string>",
  "metadata": {},
  "trial_interval_count": 500,
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": false,
  "discount_id": "<string>",
  "seats": 5000,
  "success_url": "<string>",
  "return_url": "<string>"
}
'

import requests

url = "https://api.getruba.com/v1/checkout-links/"

payload = {
    "payment_processor": "<string>",
    "product_price_id": "<string>",
    "metadata": {},
    "trial_interval_count": 500,
    "label": "<string>",
    "allow_discount_codes": True,
    "require_billing_address": False,
    "discount_id": "<string>",
    "seats": 5000,
    "success_url": "<string>",
    "return_url": "<string>"
}
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({
    payment_processor: '<string>',
    product_price_id: '<string>',
    metadata: {},
    trial_interval_count: 500,
    label: '<string>',
    allow_discount_codes: true,
    require_billing_address: false,
    discount_id: '<string>',
    seats: 5000,
    success_url: '<string>',
    return_url: '<string>'
  })
};

fetch('https://api.getruba.com/v1/checkout-links/', 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.getruba.com/v1/checkout-links/",
  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([
    'payment_processor' => '<string>',
    'product_price_id' => '<string>',
    'metadata' => [
        
    ],
    'trial_interval_count' => 500,
    'label' => '<string>',
    'allow_discount_codes' => true,
    'require_billing_address' => false,
    'discount_id' => '<string>',
    'seats' => 5000,
    'success_url' => '<string>',
    'return_url' => '<string>'
  ]),
  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.getruba.com/v1/checkout-links/"

	payload := strings.NewReader("{\n  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\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.getruba.com/v1/checkout-links/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/checkout-links/")

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  \"payment_processor\": \"<string>\",\n  \"product_price_id\": \"<string>\",\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "client_secret": "<string>",
  "success_url": "<string>",
  "return_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "seats": 123,
  "organization_id": "<string>",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "amount_type": "<string>",
          "price_currency": "<string>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "selectable": true,
          "deletable": true,
          "is_deleted": true,
          "organization_id": "<string>"
        }
      ],
      "medias": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "name": "<string>",
          "path": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "storage_version": "<string>",
          "checksum_etag": "<string>",
          "checksum_sha256_base64": "<string>",
          "checksum_sha256_hex": "<string>",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "version": "<string>",
          "service": "<string>",
          "is_uploaded": true,
          "created_at": "2023-11-07T05:31:56Z",
          "size_readable": "<string>",
          "public_url": "<string>"
        }
      ]
    }
  ],
  "discount": {
    "amount": 123,
    "currency": "<string>",
    "amounts": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "max_redemptions": 123,
    "redemptions_count": 123,
    "organization_id": "<string>"
  },
  "url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Create Checkout Link

Intent

When to call it

Access boundary

Successful result

Authorizations

Body

Response