How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Primer Client Session API API

The Client Session API API from Primer — 1 operation(s) for client session api.

Primer Client Session API API is one of 5 APIs that Primer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Client Session API. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 1 path, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 2.4.

Requests are made against 2 base URLs: https://api.sandbox.primer.io, https://api.primer.io.

3 operations 1 paths 46 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.4
Base URL
https://api.primer.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Primer Client Session API API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Client Session API 3
POST
/client-session
Create a client session
create_client_side_token_client_session_post 1 param body → 200400422
GET
/client-session
Retrieve a client session
retrieve_client_side_token_client_session_get 2 params → 200400422
PATCH
/client-session
Update client session
update_client_side_token_client_session_patch 1 param body → 200400422

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are CheckoutPaymentMethodOptionCardNetworkAPISchema (17 properties), ClientSessionWithTokenAPIResponse (11 properties), OrderLineItemsAPISchema (10 properties), ClientSessionUpdateAPIRequest (9 properties). Each schema is shown below with its type and property counts.

OrderLineItemsAPISchema
object
The details of the line items of the order. The total amount of a line item is calculated like so: totalAmount = (amount quantity) - discountAmount + taxAmount
10 properties 1 required
ProductTypeEnum
string
An enumeration
ClientSessionAPIRequest
object
8 properties
OrderLineItemsProductDataAPISchema
object
Details related to the product
8 properties
ApplePayLabel
string
Display label shown in the Apple Pay sheet to describe this billing option.
ClientSessionWarningsAPIResponse
object
3 properties
RecurringTransactionTypeEnum
string
An enumeration.
ApplePayRegularBilling
object
6 properties 1 required
AuthorizationTypeEnum
string
Type of authorization for the payment.
CheckoutPaymentMethodOptionsAPISchema
object
9 properties
CustomerDetailsAPISchema
object
8 properties
400ErrorResponse
object
1 property 1 required
422ErrorResponse
object
1 property 1 required
ApplePayDeferredRequest
object
6 properties 2 required
FirstPaymentReasonEnum
string
The reason for the first payment. This is used for informing payment processors about the specific reason a payment method is being stored. Defaults to None if…
ApplePayRecurringRequest
object
5 properties 2 required
ErrorObject
object
An object containing information about the error that occurred.
5 properties 2 required
ApplePayTrialBilling
object
6 properties 1 required
ApplePayManagementUrl
string
URL where users can manage or cancel their Apple Pay billing agreements or subscriptions.
ApplePayIntervalCount
integer
Number of calendar units that make up the full recurring interval (e.g., 1 = monthly).
Amount
integer
Charge amount in minor units (e.g., 500 = $5.00). Some currencies, such as Japanese Yen, do not have minor units. In this case, use the value as-is (e.g., ¥100…
ClientSessionUpdateAPIRequest
object
9 properties
CheckoutCustomerDetailsAPISchema
object
8 properties
CheckoutPaymentMethodOptionCardNetworkSurchargeAPISchema
object
1 property
OrderDetailsAPISchema
object
5 properties
OptionalAddressAPISchema
object
8 properties
ClientSessionWithTokenAPIResponse
object
11 properties 2 required
ApplePayPaymentDescription
string
Text shown to the user during Apple Pay authorization.
CardNetworkEnum
string
The list of available card networks.
OrderFeesAPISchema
object
3 properties 1 required
CheckoutPaymentMethodOptionAPISchema
object
Options for the payment method of type PAYMENTMETHODTYPE.
3 properties 1 required
CheckoutPaymentMethodApplePayOptionAPISchema
object
Apple Pay configuration used in a client session's payment method options.
4 properties
CheckoutPaymentMethodOptionExtraMerchantDataAPISchema
object
CheckoutPaymentMethodOptionSurchargeAPISchema
object
1 property
ApplePayIntervalUnit
string
Calendar unit representing part of a recurring billing interval.
ApplePayDeferredBilling
object
3 properties 2 required
OrderShippingAPISchema
object
4 properties
CheckoutPaymentMethodOptionCardNetworkAPISchema
object
17 properties
ClientSessionAPIResponse
object
8 properties
ApplePayAutomaticReloadBilling
object
3 properties 2 required
CountryCodeEnum
2-letter country code in ISO 3166-1 alpha format, e.g. FR for France and GB for the United Kingdom.
CheckoutPaymentMethodCardOptionAPISchema
object
2 properties
RecurringPaymentTypeSchema
Payment types, primarily to be used for recurring payments. See the table below for all possible values. Note: if no field is set, we will return a blank value…
ApplePayBillingAgreement
string
Terms and conditions the user agrees to when authorizing Apple Pay billing.
ApplePayAutomaticReloadRequest
object
4 properties 2 required
Currency
3-letter currency code in ISO 4217 format, e.g. USD for US dollars.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

primer-client-session-api-api-openapi.yml Raw ↑

Other APIs Primer publishes across the network.

Primer Dispute & Chargebacks Webhooks API
Primer Payment Methods API API
Primer Payment Webhooks API
Primer Payments API API
Where this information came from

This is an independent, third-party profile of Primer Client Session API API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.