Start a checkout for a paid plan

POST

/v1/billing/checkout

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://oddslink.app/v1/billing/checkout"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"plan\": \"api_growth\", \"interval\": \"year\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://oddslink.app/v1/billing/checkout"

  payload := strings.NewReader("{ \"plan\": \"api_growth\", \"interval\": \"year\" }")

  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(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"plan\": \"api_growth\", \"interval\": \"year\" }");
Request request = new Request.Builder()
  .url("https://oddslink.app/v1/billing/checkout")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const url = 'https://oddslink.app/v1/billing/checkout';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"plan":"api_growth","interval":"year"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://oddslink.app/v1/billing/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "plan": "api_growth", "interval": "year" }'

Signed-in website session only; an X-API-Key is refused, so a leaked key cannot spend the account’s money. Returns an order and the values the card form on the account page needs to check the card and save it with Tranzila; it charges nothing. The first charge happens on our side once the card is saved. The buyer is bound to the signed-in account server-side, so the plan, interval and add-on are the only things the caller controls: a price, customer_id or return URL in the request body is ignored. Free needs no checkout. An account that already has a subscription is refused with ALREADY_SUBSCRIBED; use /v1/billing/change.

Authorizations

BearerAuth

Request Body^required

application/json

object

plan

required

The plan. api_free is not accepted, because it costs nothing.

string

Allowed values: api_starter api_growth api_scale api_business

interval

Billing period. Yearly is the same ladder at a 20% discount.

string

default: month

Allowed values: month year

addon

Include the live-feed add-on. Accepted only with api_growth and api_scale.

boolean

Examples

Buy Growth, billed yearly

{
  "plan": "api_growth",
  "interval": "year"
}

Buy Growth with the live-feed add-on

{
  "plan": "api_growth",
  "addon": true
}

Responses

200

The order, and what the card form on the account page needs.

application/json

object

order_id

required

The checkout this card will pay for. It expires after two hours.

string format: uuid

fields

required

Values for the card form. Single use; they expire after 20 minutes.

object

terminal

required

string

thtk

required

string

amount

required

The amount of the card check, not the price. The card check charges nothing.

string

currency

required

string

Example

{
  "order_id": "3ab8e2fc-bcdd-4d52-bcee-f263208816bb",
  "fields": {
    "terminal": "oddslink",
    "thtk": "w5e8c1d2f0a94b7e8c1d2f0a94b7e8c1d2f0a94b7e",
    "amount": "1",
    "currency": "USD"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

400

A parameter was malformed.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "commenceTimeFrom is not a valid ISO-8601 timestamp.",
    "docs_url": "https://oddslink.app/docs/errors/#bad-request",
    "request_id": "req_01hz8k3z9e2v6w1x"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

401

The Authorization bearer session is missing or invalid.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Examples

No Authorization: Bearer header sent

{
  "error": {
    "code": "MISSING_SESSION",
    "message": "Sign in and try again.",
    "docs_url": "https://oddslink.app/docs/errors/#missing-session",
    "request_id": "req_01hz8k4b9h5y0z1a"
  }
}

Session is expired or invalid

{
  "error": {
    "code": "INVALID_SESSION",
    "message": "Your session has expired. Sign in again.",
    "docs_url": "https://oddslink.app/docs/errors/#invalid-session",
    "request_id": "req_01hz8k4c0j6z1a2b"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

409

This account already has a subscription.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "ALREADY_SUBSCRIBED",
    "message": "this account already has a subscription; change it instead",
    "docs_url": "https://oddslink.app/docs/errors/#already-subscribed",
    "request_id": "req_01J8Z5Q2K9V3N7M4"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

429

The plan’s speed limit was exceeded; wait Retry-After seconds. A call that does not count against the allowance is never refused for a spent allowance.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "SPEED_LIMIT",
    "message": "Speed limit exceeded: 10 requests/second on the Growth plan.",
    "docs_url": "https://oddslink.app/docs/errors/#speed-limit",
    "request_id": "req_01hz8k4f7m9c3d8f"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

Retry-After

integer

Seconds to wait before retrying on 429 SPEED_LIMIT or 503 ODDS_UNAVAILABLE.

502

The billing provider could not be reached.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "BILLING_UNAVAILABLE",
    "message": "could not reach the billing provider; try again",
    "docs_url": "https://oddslink.app/docs/errors/#billing-unavailable",
    "request_id": "req_01J8Z5Q2K9V3N7M4"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

503

Billing is not configured on this deployment. Fails closed rather than taking money it cannot then account for.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "BILLING_NOT_CONFIGURED",
    "message": "billing is not configured on this deployment",
    "docs_url": "https://oddslink.app/docs/errors/#billing-not-configured",
    "request_id": "req_01J8Z5Q2K9V3N7M4"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

5XX

Something failed on our side.

application/json

object

error

required

object

code

required

string

message

required

string

docs_url

required

string format: uri

request_id

required

string

stored_commence_times

Stored Unix-second choices on AMBIGUOUS_EVENT or INVALID_STORED_COMMENCE_TIME; independent of dateFormat.

Array<integer>

valid_bookmakers

Valid case-sensitive book keys on INVALID_BOOKMAKER.

Array<string>

current_plan

403 only: the plan on the presented key.

string

required_plan

403 only: the lowest plan that includes this request. For history, that depends on how long ago the fixture started as well as on the endpoint.

string

Example

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side. It has been logged.",
    "docs_url": "https://oddslink.app/docs/errors/#internal-error",
    "request_id": "req_01hz8k4h8n0d4e9f"
  }
}

Headers

x-requests-used

integer

Requests used this billing period.

x-requests-remaining

integer

Requests remaining this billing period.

x-requests-last

integer

What this one call cost against the allowance (0 for a free call).

X-RateLimit-Limit

integer

This plan’s speed limit, in requests per second.

X-RateLimit-Remaining

integer

Requests left in the current one-second window.

X-RateLimit-Reset

integer

Seconds until the speed-limit window resets.

X-Request-Id

string

This request’s id, for support and for matching against error.request_id.

Start a checkout for a paid plan

Authorizations

Request Bodyrequired

Examples

Responses

200

Example

Headers

400

Example

Headers

401

Examples

Headers

409

Example

Headers

429

Example

Headers

502

Example

Headers

503

Example

Headers

5XX

Example

Headers

Request Body^required