Overview

Learn more about documenting APIs in GitBook.asndasndansdna

GitBook automatically generates pages and endpoints for your OpenAPI spec. Fully customizable and equipped with testing capabilities, your documentation has never been more powerful.

The API reference below is automatically generated from a demo OpenAPI spec in this space.

List transactions

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions

Retrieves all transactions for your merchant account.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Responses

200

Transactions retrieved successfully

application/json

Financial transaction with comprehensive payment and customer data

idstring · uuidRead-onlyRequired

Unique transaction identifier

payment_idstring · uuid · nullableOptional

Associated payment identifier

merchant_idstring · uuidOptional

Merchant identifier

provider_transaction_idstring · nullableOptional

External payment provider transaction identifier

processorstring · nullableOptional

Payment processor name (e.g., STRIPE, PRIMER)

processor_transaction_idstring · nullableOptional

Processor-specific transaction identifier

processor_merchant_idstring · nullableOptional

Processor merchant account ID (MID)

merchant_order_idstring · nullableOptional

Internal order identifier

subscription_idstring · uuid · nullableOptional

Associated subscription identifier

subscription_plan_idstring · uuid · nullableOptional

Subscription plan identifier

subscription_plan_namestring · nullableOptional

Subscription plan name

subscription_plan_website_urlstring · uri · nullableOptional

Subscription plan website URL

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

amountnumber · decimal · min: 0.01Required

Transaction amount

Example: 49.99

currencystring · min: 3 · max: 3Required

ISO 4217 currency code

Example: USDPattern: ^[A-Z]{3}$

refunded_amountnumber · decimal · nullableRead-onlyOptional

Total amount refunded

statusstring · enumRequired

Transaction lifecycle status

Possible values:

descriptionstring · max: 500 · nullableOptional

Transaction description

descriptorstring · max: 100 · nullableOptional

Statement descriptor

metadatastring · nullableOptional

Additional metadata as JSON

created_atstring · date-timeRead-onlyRequired

Creation timestamp

updated_atstring · date-timeRead-onlyRequired

Last update timestamp

settled_atstring · date-time · nullableRead-onlyOptional

Settlement timestamp

settle_afterstring · date-timeOptional

Scheduled automatic capture timestamp

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

versioninteger · int64Read-onlyOptional

Optimistic locking version

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

get

/v1/transactions

HTTPcURLJavaScriptPython

GET /v1/transactions HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "payment_id": "123e4567-e89b-12d3-a456-426614174000",
    "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider_transaction_id": "text",
    "processor": "text",
    "processor_transaction_id": "text",
    "processor_merchant_id": "text",
    "history": [
      {
        "created_at": "2026-03-07T00:59:52.928Z",
        "amount": 1,
        "currency": "text",
        "status": "text",
        "processor_transaction_id": "text",
        "processor": "text"
      }
    ],
    "merchant_order_id": "text",
    "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
    "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
    "subscription_plan_name": "text",
    "subscription_plan_website_url": "https://example.com",
    "subscription_type": "ONE_TIME",
    "amount": 49.99,
    "currency": "USD",
    "refunded_amount": 1,
    "status": "INITIATED",
    "description": "text",
    "descriptor": "text",
    "metadata": "text",
    "customer_data": {
      "customer_id": "text",
      "customer_email": "[e-mail]",
      "customer_mobile": "text",
      "customer_first_name": "text",
      "customer_last_name": "text",
      "day_of_birth": "2026-03-07",
      "billing_country": "text",
      "billing_postal_code": "text",
      "national_document_id": "text",
      "payer_email": "[e-mail]",
      "payer_first_name": "text",
      "payer_last_name": "text"
    },
    "card_data": {
      "card_first_6": "text",
      "card_last_4": "text",
      "card_fingerprint_hash": "text",
      "card_brand": "text",
      "card_funding_type": "text",
      "card_country": "text",
      "cardholder_name": "text",
      "card_exp_month": 1,
      "card_exp_year": 1,
      "payment_method": "PAYMENT_CARD",
      "payment_type": "text",
      "card_token": "text",
      "token_provider": "text",
      "network_token": "text",
      "digital_wallet_type": "text",
      "card_auth_method": "text"
    },
    "bin_data": {
      "bin_number": "text",
      "bin_range": "text",
      "issuer_name": "text",
      "issuer_country": "text",
      "issuer_currency": "text",
      "card_level": "text",
      "card_category": "text",
      "product_usage_type": "text",
      "is_regulated": true
    },
    "risk_data": {
      "risk_score": 1,
      "fraud_score": 1,
      "velocity_score": 1,
      "final_decision": "text",
      "avs_result": "text",
      "cvc_result": "text",
      "decline_code": "text",
      "verification_results": "text",
      "liability_shift": true
    },
    "processing_data": {
      "acquirer_name": "text",
      "processor_name": "text",
      "processing_fee": 1,
      "interchange_fee": 1,
      "gateway_fee": 1,
      "retry_count": 1,
      "processing_time_ms": 1
    },
    "compliance_data": {
      "three_ds_version": "text",
      "three_ds_status": "text",
      "three_ds_eci": "text",
      "cavv": "text",
      "xid": "text",
      "sca_exemption": "text",
      "sca_indicator": "text",
      "moto": true
    },
    "network_data": {
      "network_transaction_id": "text",
      "authorization_code": "text",
      "preferred_network": "text",
      "actual_network": "text",
      "network_token_used": true,
      "token_requestor_id": "text"
    },
    "order_data": {
      "order_id": "text",
      "invoice_id": "text",
      "subscription_id": "text",
      "plan_id": "text",
      "merchant_order_id": "text",
      "external_order_id": "text"
    },
    "traffic_data": {
      "traffic_source": "text",
      "website": "text",
      "ip_address": "0.0.0.0",
      "ip_country": "text",
      "ip_city": "text",
      "geo_city": "text",
      "geo_country": "text"
    },
    "routing_data": {
      "bank_mid": "text",
      "mid_descriptor": "text",
      "route_id": "text",
      "segment_id": "text",
      "cascade_number": 1
    },
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z",
    "settled_at": "2026-03-07T00:59:52.928Z",
    "settle_after": "2026-03-07T00:59:52.928Z",
    "initiation_type": "ECOMMERCE",
    "version": 1
  }
]

Search transactions

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/search

Search transactions using filters with pagination support.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Transaction search request with filters and pagination

Responses

200

Search results retrieved successfully

application/json

Transaction search results with pagination

total_elementsinteger · int64Required

Total matching transactions

total_pagesintegerRequired

Total pages available

current_pageintegerRequired

Current page number (0-based)

page_sizeintegerRequired

Items per page

has_nextbooleanOptional

More pages available

has_previousbooleanOptional

Previous pages available

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

post

/v1/transactions/search

HTTPcURLJavaScriptPython

POST /v1/transactions/search HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "filters": [
    {
      "operator": "contains",
      "field": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "size": 10
  },
  "sort": {
    "field": "text",
    "direction": "DESC"
  }
}

{
  "transactions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payment_id": "123e4567-e89b-12d3-a456-426614174000",
      "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
      "provider_transaction_id": "text",
      "processor": "text",
      "processor_transaction_id": "text",
      "processor_merchant_id": "text",
      "history": [
        {
          "created_at": "2026-03-07T00:59:52.928Z",
          "amount": 1,
          "currency": "text",
          "status": "text",
          "processor_transaction_id": "text",
          "processor": "text"
        }
      ],
      "merchant_order_id": "text",
      "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
      "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
      "subscription_plan_name": "text",
      "subscription_plan_website_url": "https://example.com",
      "subscription_type": "ONE_TIME",
      "amount": 49.99,
      "currency": "USD",
      "refunded_amount": 1,
      "status": "INITIATED",
      "description": "text",
      "descriptor": "text",
      "metadata": "text",
      "customer_data": {
        "customer_id": "text",
        "customer_email": "[e-mail]",
        "customer_mobile": "text",
        "customer_first_name": "text",
        "customer_last_name": "text",
        "day_of_birth": "2026-03-07",
        "billing_country": "text",
        "billing_postal_code": "text",
        "national_document_id": "text",
        "payer_email": "[e-mail]",
        "payer_first_name": "text",
        "payer_last_name": "text"
      },
      "card_data": {
        "card_first_6": "text",
        "card_last_4": "text",
        "card_fingerprint_hash": "text",
        "card_brand": "text",
        "card_funding_type": "text",
        "card_country": "text",
        "cardholder_name": "text",
        "card_exp_month": 1,
        "card_exp_year": 1,
        "payment_method": "PAYMENT_CARD",
        "payment_type": "text",
        "card_token": "text",
        "token_provider": "text",
        "network_token": "text",
        "digital_wallet_type": "text",
        "card_auth_method": "text"
      },
      "bin_data": {
        "bin_number": "text",
        "bin_range": "text",
        "issuer_name": "text",
        "issuer_country": "text",
        "issuer_currency": "text",
        "card_level": "text",
        "card_category": "text",
        "product_usage_type": "text",
        "is_regulated": true
      },
      "risk_data": {
        "risk_score": 1,
        "fraud_score": 1,
        "velocity_score": 1,
        "final_decision": "text",
        "avs_result": "text",
        "cvc_result": "text",
        "decline_code": "text",
        "verification_results": "text",
        "liability_shift": true
      },
      "processing_data": {
        "acquirer_name": "text",
        "processor_name": "text",
        "processing_fee": 1,
        "interchange_fee": 1,
        "gateway_fee": 1,
        "retry_count": 1,
        "processing_time_ms": 1
      },
      "compliance_data": {
        "three_ds_version": "text",
        "three_ds_status": "text",
        "three_ds_eci": "text",
        "cavv": "text",
        "xid": "text",
        "sca_exemption": "text",
        "sca_indicator": "text",
        "moto": true
      },
      "network_data": {
        "network_transaction_id": "text",
        "authorization_code": "text",
        "preferred_network": "text",
        "actual_network": "text",
        "network_token_used": true,
        "token_requestor_id": "text"
      },
      "order_data": {
        "order_id": "text",
        "invoice_id": "text",
        "subscription_id": "text",
        "plan_id": "text",
        "merchant_order_id": "text",
        "external_order_id": "text"
      },
      "traffic_data": {
        "traffic_source": "text",
        "website": "text",
        "ip_address": "0.0.0.0",
        "ip_country": "text",
        "ip_city": "text",
        "geo_city": "text",
        "geo_country": "text"
      },
      "routing_data": {
        "bank_mid": "text",
        "mid_descriptor": "text",
        "route_id": "text",
        "segment_id": "text",
        "cascade_number": 1
      },
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z",
      "settled_at": "2026-03-07T00:59:52.928Z",
      "settle_after": "2026-03-07T00:59:52.928Z",
      "initiation_type": "ECOMMERCE",
      "version": 1
    }
  ],
  "total_elements": 1,
  "total_pages": 1,
  "current_page": 1,
  "page_size": 1,
  "has_next": true,
  "has_previous": true
}

Get transaction

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/{transactionId}

Retrieves detailed information about a specific transaction.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

transactionIdstring · uuidRequired

Unique transaction identifier

Responses

200

Transaction retrieved successfully

application/json

Financial transaction with comprehensive payment and customer data

idstring · uuidRead-onlyRequired

Unique transaction identifier

payment_idstring · uuid · nullableOptional

Associated payment identifier

merchant_idstring · uuidOptional

Merchant identifier

provider_transaction_idstring · nullableOptional

External payment provider transaction identifier

processorstring · nullableOptional

Payment processor name (e.g., STRIPE, PRIMER)

processor_transaction_idstring · nullableOptional

Processor-specific transaction identifier

processor_merchant_idstring · nullableOptional

Processor merchant account ID (MID)

merchant_order_idstring · nullableOptional

Internal order identifier

subscription_idstring · uuid · nullableOptional

Associated subscription identifier

subscription_plan_idstring · uuid · nullableOptional

Subscription plan identifier

subscription_plan_namestring · nullableOptional

Subscription plan name

subscription_plan_website_urlstring · uri · nullableOptional

Subscription plan website URL

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

amountnumber · decimal · min: 0.01Required

Transaction amount

Example: 49.99

currencystring · min: 3 · max: 3Required

ISO 4217 currency code

Example: USDPattern: ^[A-Z]{3}$

refunded_amountnumber · decimal · nullableRead-onlyOptional

Total amount refunded

statusstring · enumRequired

Transaction lifecycle status

Possible values:

descriptionstring · max: 500 · nullableOptional

Transaction description

descriptorstring · max: 100 · nullableOptional

Statement descriptor

metadatastring · nullableOptional

Additional metadata as JSON

created_atstring · date-timeRead-onlyRequired

Creation timestamp

updated_atstring · date-timeRead-onlyRequired

Last update timestamp

settled_atstring · date-time · nullableRead-onlyOptional

Settlement timestamp

settle_afterstring · date-timeOptional

Scheduled automatic capture timestamp

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

versioninteger · int64Read-onlyOptional

Optimistic locking version

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

/v1/transactions/{transactionId}

HTTPcURLJavaScriptPython

GET /v1/transactions/{transactionId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payment_id": "123e4567-e89b-12d3-a456-426614174000",
  "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_transaction_id": "text",
  "processor": "text",
  "processor_transaction_id": "text",
  "processor_merchant_id": "text",
  "history": [
    {
      "created_at": "2026-03-07T00:59:52.928Z",
      "amount": 1,
      "currency": "text",
      "status": "text",
      "processor_transaction_id": "text",
      "processor": "text"
    }
  ],
  "merchant_order_id": "text",
  "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "subscription_type": "ONE_TIME",
  "amount": 49.99,
  "currency": "USD",
  "refunded_amount": 1,
  "status": "INITIATED",
  "description": "text",
  "descriptor": "text",
  "metadata": "text",
  "customer_data": {
    "customer_id": "text",
    "customer_email": "[e-mail]",
    "customer_mobile": "text",
    "customer_first_name": "text",
    "customer_last_name": "text",
    "day_of_birth": "2026-03-07",
    "billing_country": "text",
    "billing_postal_code": "text",
    "national_document_id": "text",
    "payer_email": "[e-mail]",
    "payer_first_name": "text",
    "payer_last_name": "text"
  },
  "card_data": {
    "card_first_6": "text",
    "card_last_4": "text",
    "card_fingerprint_hash": "text",
    "card_brand": "text",
    "card_funding_type": "text",
    "card_country": "text",
    "cardholder_name": "text",
    "card_exp_month": 1,
    "card_exp_year": 1,
    "payment_method": "PAYMENT_CARD",
    "payment_type": "text",
    "card_token": "text",
    "token_provider": "text",
    "network_token": "text",
    "digital_wallet_type": "text",
    "card_auth_method": "text"
  },
  "bin_data": {
    "bin_number": "text",
    "bin_range": "text",
    "issuer_name": "text",
    "issuer_country": "text",
    "issuer_currency": "text",
    "card_level": "text",
    "card_category": "text",
    "product_usage_type": "text",
    "is_regulated": true
  },
  "risk_data": {
    "risk_score": 1,
    "fraud_score": 1,
    "velocity_score": 1,
    "final_decision": "text",
    "avs_result": "text",
    "cvc_result": "text",
    "decline_code": "text",
    "verification_results": "text",
    "liability_shift": true
  },
  "processing_data": {
    "acquirer_name": "text",
    "processor_name": "text",
    "processing_fee": 1,
    "interchange_fee": 1,
    "gateway_fee": 1,
    "retry_count": 1,
    "processing_time_ms": 1
  },
  "compliance_data": {
    "three_ds_version": "text",
    "three_ds_status": "text",
    "three_ds_eci": "text",
    "cavv": "text",
    "xid": "text",
    "sca_exemption": "text",
    "sca_indicator": "text",
    "moto": true
  },
  "network_data": {
    "network_transaction_id": "text",
    "authorization_code": "text",
    "preferred_network": "text",
    "actual_network": "text",
    "network_token_used": true,
    "token_requestor_id": "text"
  },
  "order_data": {
    "order_id": "text",
    "invoice_id": "text",
    "subscription_id": "text",
    "plan_id": "text",
    "merchant_order_id": "text",
    "external_order_id": "text"
  },
  "traffic_data": {
    "traffic_source": "text",
    "website": "text",
    "ip_address": "0.0.0.0",
    "ip_country": "text",
    "ip_city": "text",
    "geo_city": "text",
    "geo_country": "text"
  },
  "routing_data": {
    "bank_mid": "text",
    "mid_descriptor": "text",
    "route_id": "text",
    "segment_id": "text",
    "cascade_number": 1
  },
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "settled_at": "2026-03-07T00:59:52.928Z",
  "settle_after": "2026-03-07T00:59:52.928Z",
  "initiation_type": "ECOMMERCE",
  "version": 1
}

Void transaction

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/{transactionId}/void

Voids an authorized transaction, preventing it from being captured. Only transactions in AUTHORIZED status can be voided.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

transactionIdstring · uuidRequired

Unique transaction identifier

Header parameters

X-Idempotency-Keystring · max: 255Required

Unique key to ensure idempotent requests. Max 255 characters.

Body

application/json

Void request

reason_codestring · enumRequiredPossible values:

notesstring · max: 500 · nullableOptional

Additional notes

cancel_subscriptionbooleanOptional

Whether to cancel associated subscription

Default: false

subscription_cancellation_typestring · enumOptional

When to cancel the subscription:

• IMMEDIATE: Cancel immediately
• END_OF_CYCLE: Cancel at the end of current billing period

Possible values:

Responses

201

Void request accepted

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

422

Invalid operation for current resource state

application/json

500

Internal server error

application/json

post

/v1/transactions/{transactionId}/void

HTTPcURLJavaScriptPython

POST /v1/transactions/{transactionId}/void HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
X-Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "reason_code": "CLIENT_REQUESTED",
  "notes": "text",
  "cancel_subscription": false,
  "subscription_cancellation_type": "IMMEDIATE"
}

No content

Capture transaction

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/{transactionId}/capture

Captures an authorized transaction. Only transactions in AUTHORIZED status can be captured. The capture can be for the full authorized amount or a partial amount (if supported by the processor).

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

transactionIdstring · uuidRequired

Unique transaction identifier

Header parameters

X-Idempotency-Keystring · max: 255Required

Unique key to ensure idempotent requests. Max 255 characters.

Body

application/json

Capture request

amountnumber · decimal · min: 0.01 · nullableOptional

Amount to capture (omit for full amount)

Responses

201

Capture request accepted

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

422

Invalid operation for current resource state

application/json

500

Internal server error

application/json

post

/v1/transactions/{transactionId}/capture

HTTPcURLJavaScriptPython

POST /v1/transactions/{transactionId}/capture HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
X-Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "amount": 1
}

No content

Refund transaction

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/{transactionId}/refund

Creates a refund for a captured transaction. The refund can be partial or full, depending on the amount specified.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

transactionIdstring · uuidRequired

Unique transaction identifier

Header parameters

X-Idempotency-Keystring · max: 255Required

Unique key to ensure idempotent requests. Max 255 characters.

Body

application/json

Refund request

amountnumber · decimal · min: 0.01Required

Amount to refund

reason_codestring · enumRequiredPossible values:

notesstring · max: 500 · nullableOptional

Additional notes

cancel_subscriptionbooleanOptional

Whether to cancel associated subscription

Default: false

subscription_cancellation_typestring · enumOptional

When to cancel the subscription:

• IMMEDIATE: Cancel immediately
• END_OF_CYCLE: Cancel at the end of current billing period

Possible values:

Responses

201

Refund request accepted

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

422

Invalid operation for current resource state

application/json

500

Internal server error

application/json

post

/v1/transactions/{transactionId}/refund

HTTPcURLJavaScriptPython

POST /v1/transactions/{transactionId}/refund HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
X-Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "amount": 1,
  "reason_code": "CLIENT_REQUESTED",
  "notes": "text",
  "cancel_subscription": false,
  "subscription_cancellation_type": "IMMEDIATE"
}

No content

Export transactions to CSV

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/export/csv

Export transactions to CSV format with optional filters. Maximum 10,000 records.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Transaction export request with filters

exclude_fieldsstring[] · max: 50Optional

Field paths to exclude from export

Example: ["customerData.customerEmail","cardData.cardLast4"]

Responses

200

CSV file generated

text/csv

Responsestring · binary

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

408

Export timeout - request took too long to process

application/json

500

Internal server error

application/json

post

/v1/transactions/export/csv

HTTPcURLJavaScriptPython

POST /v1/transactions/export/csv HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "filters": [
    {
      "operator": "contains",
      "field": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "exclude_fields": [
    "customerData.customerEmail",
    "cardData.cardLast4"
  ]
}

binary

Export transactions to Excel

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/transactions/export/xlsx

Export transactions to Excel format with optional filters. Maximum 10,000 records.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Transaction export request with filters

exclude_fieldsstring[] · max: 50Optional

Field paths to exclude from export

Example: ["customerData.customerEmail","cardData.cardLast4"]

Responses

200

Excel file generated

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Responsestring · binary

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

408

Export timeout - request took too long to process

application/json

500

Internal server error

application/json

post

/v1/transactions/export/xlsx

HTTPcURLJavaScriptPython

POST /v1/transactions/export/xlsx HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "filters": [
    {
      "operator": "contains",
      "field": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "exclude_fields": [
    "customerData.customerEmail",
    "cardData.cardLast4"
  ]
}

binary

List payments

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/payments

Retrieves all payments for your merchant account.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Responses

200

Payments retrieved successfully

application/json

Payment response

idstring · uuidRequired

Unique payment identifier

merchant_idstring · uuidRequired

Merchant identifier

providerstring · enumRequiredPossible values:

provider_idstringOptional

Provider-specific payment identifier

amountnumber · decimalRequired

Payment amount

settled_amountnumber · decimalOptional

Amount captured/settled

refunded_amountnumber · decimalOptional

Total amount refunded

currencystringRequired

Currency code

statusstring · enumRequiredPossible values:

typestring · enumRequired

Payment type

Possible values:

descriptionstringOptional

Payment description

customer_idstringOptional

Customer identifier

order_idstringOptional

Order identifier

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

captured_atstring · date-timeOptional

voided_atstring · date-timeOptional

refunded_atstring · date-timeOptional

settle_afterstring · date-timeOptional

void_reason_codestring · enumOptionalPossible values:

void_notesstringOptional

refund_reason_codestring · enumOptionalPossible values:

refund_notesstringOptional

descriptorstringOptional

subscription_plan_idstring · uuidOptional

subscription_plan_namestringOptional

subscription_plan_website_urlstring · uriOptional

subscription_idstring · uuidOptional

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

get

/v1/payments

HTTPcURLJavaScriptPython

GET /v1/payments HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider": "PRIMER",
    "provider_id": "text",
    "amount": 1,
    "settled_amount": 1,
    "refunded_amount": 1,
    "currency": "text",
    "status": "INITIATED",
    "type": "PAYMENT",
    "description": "text",
    "customer_id": "text",
    "order_id": "text",
    "order": {
      "id": "text",
      "order_id": "text",
      "country_code": "text",
      "line_items": [
        {
          "id": "text",
          "amount": 1,
          "item_id": "text",
          "name": "text",
          "description": "text",
          "quantity": 1,
          "discount_amount": 1,
          "tax_amount": 1,
          "tax_code": "text",
          "product_type": "PHYSICAL",
          "product_data": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "shipping": {
        "id": "text",
        "amount": 1,
        "expectation": "STANDARD"
      }
    },
    "customer": {
      "id": "text",
      "customer_id": "text",
      "email_address": "[e-mail]",
      "mobile_number": "text",
      "first_name": "text",
      "last_name": "text",
      "national_document_id": "text",
      "billing_address": {
        "id": "text",
        "first_name": "text",
        "last_name": "text",
        "address_line1": "text",
        "address_line2": "text",
        "city": "text",
        "state": "text",
        "country_code": "text",
        "postal_code": "text"
      },
      "shipping_address": {
        "id": "text",
        "first_name": "text",
        "last_name": "text",
        "address_line1": "text",
        "address_line2": "text",
        "city": "text",
        "state": "text",
        "country_code": "text",
        "postal_code": "text"
      }
    },
    "payment_method": {
      "id": "text",
      "authorization_type": "text",
      "payment_method_token": "text",
      "is_vaulted": true,
      "analytics_id": "text",
      "payment_method_type": "PAYMENT_CARD",
      "payment_method_data": {
        "id": "text",
        "last4_digits": "text",
        "first6_digits": "text",
        "expiration_month": "text",
        "expiration_year": "text",
        "cardholder_name": "text",
        "network": "text",
        "is_network_tokenized": true,
        "bin_data": {
          "id": "text",
          "network": "text",
          "issuer_country_code": "text",
          "issuer_name": "text",
          "issuer_currency_code": "text",
          "regional_restriction": "text",
          "account_number_type": "text",
          "account_funding_type": "text",
          "prepaid_reloadable_indicator": "text",
          "product_usage_type": "text",
          "product_code": "text",
          "product_name": "text"
        }
      }
    },
    "transactions": [
      {
        "id": "text",
        "transaction_date": "2026-03-07T00:59:52.928Z",
        "amount": 1,
        "currency_code": "text",
        "transaction_type": "text",
        "order_id": "text",
        "processor_transaction_id": "text",
        "processor_name": "text",
        "processor_merchant_id": "text",
        "processor_status": "PENDING",
        "card_token_type": "text",
        "created_at": "2026-03-07T00:59:52.928Z",
        "updated_at": "2026-03-07T00:59:52.928Z"
      }
    ],
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z",
    "captured_at": "2026-03-07T00:59:52.928Z",
    "voided_at": "2026-03-07T00:59:52.928Z",
    "refunded_at": "2026-03-07T00:59:52.928Z",
    "settle_after": "2026-03-07T00:59:52.928Z",
    "void_reason_code": "CLIENT_REQUESTED",
    "void_notes": "text",
    "refund_reason_code": "CLIENT_REQUESTED",
    "refund_notes": "text",
    "descriptor": "text",
    "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
    "subscription_plan_name": "text",
    "subscription_plan_website_url": "https://example.com",
    "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
    "subscription_type": "ONE_TIME",
    "initiation_type": "ECOMMERCE",
    "status_reason": {
      "type": "APPLICATION_ERROR",
      "decline_type": "SOFT_DECLINE",
      "code": "ERROR",
      "message": "text"
    }
  }
]

Create payment

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/payments

Creates a merchant-initiated payment using a stored payment method token and customer ID. This is typically used for recurring payments or one-click checkout.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Header parameters

X-Idempotency-Keystring · max: 255Required

Unique key to ensure idempotent requests. Max 255 characters.

Body

application/json

Create payment request

payment_method_tokenstringRequired

Token representing the stored payment method

customer_idstringRequired

Your unique customer identifier

order_idstringOptional

Your unique order identifier

amountnumber · decimal · min: 0.01Required

Amount in major units (e.g., 49.99 for £49.99)

currency_codestringRequired

3-letter ISO 4217 currency code

Pattern: ^[A-Z]{3}$

payment_providerstring · enumOptionalPossible values:

subscription_plan_idstring · uuidOptional

Subscription plan identifier

subscription_idstring · uuidOptional

Subscription identifier

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

subscription_plan_namestringOptional

Subscription plan name

subscription_plan_website_urlstring · uriOptional

Subscription plan website URL

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

settle_afterstring · date-timeOptional

Scheduled automatic settlement timestamp

Responses

201

Payment created successfully

application/json

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

422

Invalid operation for current resource state

application/json

500

Internal server error

application/json

post

/v1/payments

HTTPcURLJavaScriptPython

POST /v1/payments HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
X-Idempotency-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 1534

{
  "payment_method_token": "text",
  "customer_id": "text",
  "order_id": "text",
  "amount": 1,
  "currency_code": "text",
  "order": {
    "country_code": "text",
    "line_items": [
      {
        "amount": 1,
        "item_id": "text",
        "name": "text",
        "description": "text",
        "quantity": 1,
        "discount_amount": 1,
        "tax_amount": 1,
        "tax_code": "text",
        "product_type": "PHYSICAL",
        "product_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "fees": [
      {
        "type": "text",
        "amount": 1,
        "description": "text"
      }
    ],
    "shipping": {
      "amount": 1,
      "method_id": "text",
      "method_name": "text",
      "method_description": "text"
    }
  },
  "customer": {
    "email_address": "[e-mail]",
    "mobile_number": "text",
    "first_name": "text",
    "last_name": "text",
    "billing_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "shipping_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "national_document_id": "text"
  },
  "payment_method": {
    "vault_on_success": false,
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "descriptor": "text",
    "payment_type": "FIRST_PAYMENT"
  },
  "payment_provider": "PRIMER",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_type": "ONE_TIME",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "initiation_type": "ECOMMERCE",
  "settle_after": "2026-03-07T00:59:52.928Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "PRIMER",
  "provider_id": "text",
  "amount": 1,
  "settled_amount": 1,
  "refunded_amount": 1,
  "currency": "text",
  "status": "INITIATED",
  "type": "PAYMENT",
  "description": "text",
  "customer_id": "text",
  "order_id": "text",
  "order": {
    "id": "text",
    "order_id": "text",
    "country_code": "text",
    "line_items": [
      {
        "id": "text",
        "amount": 1,
        "item_id": "text",
        "name": "text",
        "description": "text",
        "quantity": 1,
        "discount_amount": 1,
        "tax_amount": 1,
        "tax_code": "text",
        "product_type": "PHYSICAL",
        "product_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "shipping": {
      "id": "text",
      "amount": 1,
      "expectation": "STANDARD"
    }
  },
  "customer": {
    "id": "text",
    "customer_id": "text",
    "email_address": "[e-mail]",
    "mobile_number": "text",
    "first_name": "text",
    "last_name": "text",
    "national_document_id": "text",
    "billing_address": {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "shipping_address": {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    }
  },
  "payment_method": {
    "id": "text",
    "authorization_type": "text",
    "payment_method_token": "text",
    "is_vaulted": true,
    "analytics_id": "text",
    "payment_method_type": "PAYMENT_CARD",
    "payment_method_data": {
      "id": "text",
      "last4_digits": "text",
      "first6_digits": "text",
      "expiration_month": "text",
      "expiration_year": "text",
      "cardholder_name": "text",
      "network": "text",
      "is_network_tokenized": true,
      "bin_data": {
        "id": "text",
        "network": "text",
        "issuer_country_code": "text",
        "issuer_name": "text",
        "issuer_currency_code": "text",
        "regional_restriction": "text",
        "account_number_type": "text",
        "account_funding_type": "text",
        "prepaid_reloadable_indicator": "text",
        "product_usage_type": "text",
        "product_code": "text",
        "product_name": "text"
      }
    }
  },
  "transactions": [
    {
      "id": "text",
      "transaction_date": "2026-03-07T00:59:52.928Z",
      "amount": 1,
      "currency_code": "text",
      "transaction_type": "text",
      "order_id": "text",
      "processor_transaction_id": "text",
      "processor_name": "text",
      "processor_merchant_id": "text",
      "processor_status": "PENDING",
      "card_token_type": "text",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "captured_at": "2026-03-07T00:59:52.928Z",
  "voided_at": "2026-03-07T00:59:52.928Z",
  "refunded_at": "2026-03-07T00:59:52.928Z",
  "settle_after": "2026-03-07T00:59:52.928Z",
  "void_reason_code": "CLIENT_REQUESTED",
  "void_notes": "text",
  "refund_reason_code": "CLIENT_REQUESTED",
  "refund_notes": "text",
  "descriptor": "text",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_type": "ONE_TIME",
  "initiation_type": "ECOMMERCE",
  "status_reason": {
    "type": "APPLICATION_ERROR",
    "decline_type": "SOFT_DECLINE",
    "code": "ERROR",
    "message": "text"
  }
}

Get payment

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/payments/{paymentId}

Retrieves detailed information about a specific payment.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

paymentIdstring · uuidRequired

Unique payment identifier

Responses

200

Payment retrieved successfully

application/json

Payment response

idstring · uuidRequired

Unique payment identifier

merchant_idstring · uuidRequired

Merchant identifier

providerstring · enumRequiredPossible values:

provider_idstringOptional

Provider-specific payment identifier

amountnumber · decimalRequired

Payment amount

settled_amountnumber · decimalOptional

Amount captured/settled

refunded_amountnumber · decimalOptional

Total amount refunded

currencystringRequired

Currency code

statusstring · enumRequiredPossible values:

typestring · enumRequired

Payment type

Possible values:

descriptionstringOptional

Payment description

customer_idstringOptional

Customer identifier

order_idstringOptional

Order identifier

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

captured_atstring · date-timeOptional

voided_atstring · date-timeOptional

refunded_atstring · date-timeOptional

settle_afterstring · date-timeOptional

void_reason_codestring · enumOptionalPossible values:

void_notesstringOptional

refund_reason_codestring · enumOptionalPossible values:

refund_notesstringOptional

descriptorstringOptional

subscription_plan_idstring · uuidOptional

subscription_plan_namestringOptional

subscription_plan_website_urlstring · uriOptional

subscription_idstring · uuidOptional

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

/v1/payments/{paymentId}

HTTPcURLJavaScriptPython

GET /v1/payments/{paymentId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "PRIMER",
  "provider_id": "text",
  "amount": 1,
  "settled_amount": 1,
  "refunded_amount": 1,
  "currency": "text",
  "status": "INITIATED",
  "type": "PAYMENT",
  "description": "text",
  "customer_id": "text",
  "order_id": "text",
  "order": {
    "id": "text",
    "order_id": "text",
    "country_code": "text",
    "line_items": [
      {
        "id": "text",
        "amount": 1,
        "item_id": "text",
        "name": "text",
        "description": "text",
        "quantity": 1,
        "discount_amount": 1,
        "tax_amount": 1,
        "tax_code": "text",
        "product_type": "PHYSICAL",
        "product_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "shipping": {
      "id": "text",
      "amount": 1,
      "expectation": "STANDARD"
    }
  },
  "customer": {
    "id": "text",
    "customer_id": "text",
    "email_address": "[e-mail]",
    "mobile_number": "text",
    "first_name": "text",
    "last_name": "text",
    "national_document_id": "text",
    "billing_address": {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "shipping_address": {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    }
  },
  "payment_method": {
    "id": "text",
    "authorization_type": "text",
    "payment_method_token": "text",
    "is_vaulted": true,
    "analytics_id": "text",
    "payment_method_type": "PAYMENT_CARD",
    "payment_method_data": {
      "id": "text",
      "last4_digits": "text",
      "first6_digits": "text",
      "expiration_month": "text",
      "expiration_year": "text",
      "cardholder_name": "text",
      "network": "text",
      "is_network_tokenized": true,
      "bin_data": {
        "id": "text",
        "network": "text",
        "issuer_country_code": "text",
        "issuer_name": "text",
        "issuer_currency_code": "text",
        "regional_restriction": "text",
        "account_number_type": "text",
        "account_funding_type": "text",
        "prepaid_reloadable_indicator": "text",
        "product_usage_type": "text",
        "product_code": "text",
        "product_name": "text"
      }
    }
  },
  "transactions": [
    {
      "id": "text",
      "transaction_date": "2026-03-07T00:59:52.928Z",
      "amount": 1,
      "currency_code": "text",
      "transaction_type": "text",
      "order_id": "text",
      "processor_transaction_id": "text",
      "processor_name": "text",
      "processor_merchant_id": "text",
      "processor_status": "PENDING",
      "card_token_type": "text",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "captured_at": "2026-03-07T00:59:52.928Z",
  "voided_at": "2026-03-07T00:59:52.928Z",
  "refunded_at": "2026-03-07T00:59:52.928Z",
  "settle_after": "2026-03-07T00:59:52.928Z",
  "void_reason_code": "CLIENT_REQUESTED",
  "void_notes": "text",
  "refund_reason_code": "CLIENT_REQUESTED",
  "refund_notes": "text",
  "descriptor": "text",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_type": "ONE_TIME",
  "initiation_type": "ECOMMERCE",
  "status_reason": {
    "type": "APPLICATION_ERROR",
    "decline_type": "SOFT_DECLINE",
    "code": "ERROR",
    "message": "text"
  }
}

Create client session

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/payments/client-session

Creates a client session and generates a client token - a temporary key used to initialize the Payment Iframe and authenticate it against your account. Client tokens expire after 24 hours.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Client session request

order_idstringOptional

Your unique order identifier

currency_codestringOptional

3-letter ISO 4217 currency code

amountnumber · decimalOptional

Amount in major units

customer_idstringOptional

Your unique customer identifier

payment_providerstring · enumOptionalPossible values:

localestringOptional

Locale for UI (e.g., en-GB, es-ES)

payment_flowstring · enumOptionalDefault: DEFAULTPossible values:

subscription_plan_idstring · uuidOptional

subscription_plan_namestringOptional

subscription_plan_website_urlstring · uriOptional

subscription_idstring · uuidOptional

subscription_typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

initiation_typestring · enumOptional

Payment initiation context:

• ECOMMERCE: Standard e-commerce payment
• SUBSCRIPTION_FIRST_TIME: Initial subscription payment
• SUBSCRIPTION_RENEWAL: Recurring subscription payment
• UNSCHEDULED: Merchant-initiated payment

Possible values:

settle_afterstring · date-timeOptional

Responses

201

Client session created successfully

application/json

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

post

/v1/payments/client-session

HTTPcURLJavaScriptPython

POST /v1/payments/client-session HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1545

{
  "order_id": "text",
  "currency_code": "text",
  "amount": 1,
  "customer_id": "text",
  "order": {
    "country_code": "text",
    "line_items": [
      {
        "amount": 1,
        "item_id": "text",
        "name": "text",
        "description": "text",
        "quantity": 1,
        "discount_amount": 1,
        "tax_amount": 1,
        "tax_code": "text",
        "product_type": "PHYSICAL",
        "product_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "fees": [
      {
        "type": "text",
        "amount": 1,
        "description": "text"
      }
    ],
    "shipping": {
      "amount": 1,
      "method_id": "text",
      "method_name": "text",
      "method_description": "text"
    }
  },
  "customer": {
    "email_address": "[e-mail]",
    "mobile_number": "text",
    "first_name": "text",
    "last_name": "text",
    "billing_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "shipping_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "national_document_id": "text"
  },
  "payment_method": {
    "vault_on_success": false,
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "descriptor": "text",
    "payment_type": "FIRST_PAYMENT"
  },
  "payment_provider": "PRIMER",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "locale": "text",
  "payment_flow": "DEFAULT",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "subscription_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_type": "ONE_TIME",
  "initiation_type": "ECOMMERCE",
  "settle_after": "2026-03-07T00:59:52.928Z"
}

{
  "client_token": {
    "token": "text",
    "expires_at": "2026-03-07T00:59:52.928Z"
  },
  "client_session_id": "text",
  "order_id": "text",
  "currency_code": "text",
  "amount": 1,
  "customer_id": "text",
  "order": {
    "country_code": "text",
    "line_items": [
      {
        "amount": 1,
        "item_id": "text",
        "name": "text",
        "description": "text",
        "quantity": 1,
        "discount_amount": 1,
        "tax_amount": 1,
        "tax_code": "text",
        "product_type": "PHYSICAL",
        "product_data": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "fees": [
      {
        "type": "text",
        "amount": 1,
        "description": "text"
      }
    ],
    "shipping": {
      "amount": 1,
      "method_id": "text",
      "method_name": "text",
      "method_description": "text"
    }
  },
  "customer": {
    "email_address": "[e-mail]",
    "mobile_number": "text",
    "first_name": "text",
    "last_name": "text",
    "billing_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "shipping_address": {
      "first_name": "text",
      "last_name": "text",
      "address_line1": "text",
      "address_line2": "text",
      "city": "text",
      "state": "text",
      "country_code": "text",
      "postal_code": "text"
    },
    "national_document_id": "text"
  },
  "payment_method": {
    "vault_on_success": false,
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "descriptor": "text",
    "payment_type": "FIRST_PAYMENT"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "warnings": [
    "text"
  ],
  "required_actions": [
    "text"
  ],
  "test_mode": true,
  "subscription_plan_id": "text",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "subscription_id": "text",
  "subscription_type": "ONE_TIME",
  "initiation_type": "ECOMMERCE",
  "settle_after": "2026-03-07T00:59:52.928Z"
}

List subscriptions

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscriptions

Retrieves all subscriptions for your merchant account.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Responses

200

Subscriptions retrieved successfully

application/json

idstring · uuidOptional

Subscription ID

subscription_plan_idstring · uuidOptional

Subscription Plan ID

merchant_idstring · uuidOptional

Merchant ID

customer_idstringOptional

Customer identifier

emailstring · emailOptional

Customer email address

payment_methodstring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

term_numberintegerOptional

Current billing term number

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

start_datestring · date-timeOptional

cancellation_datestring · date-timeOptional

expired_atstring · date-timeOptional

next_charge_atstring · date-timeOptional

pause_start_atstring · date-timeOptional

pause_end_atstring · date-timeOptional

trialbooleanOptional

Whether in trial period

trial_started_atstring · date-timeOptional

trial_ends_atstring · date-timeOptional

cancellation_typestring · enumOptional

When to cancel the subscription:

• IMMEDIATE: Cancel immediately
• END_OF_CYCLE: Cancel at the end of current billing period

Possible values:

cancellation_reason_codestring · enumOptionalPossible values:

effective_end_atstring · date-timeOptional

When subscription access ends

retry_attempt_countintegerOptionalDefault: 0

last_retry_atstring · date-timeOptional

next_retry_atstring · date-timeOptional

product_urlstringOptional

Product URL from subscription plan

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

get

/v1/subscriptions

HTTPcURLJavaScriptPython

GET /v1/subscriptions HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
    "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
    "customer_id": "text",
    "email": "[e-mail]",
    "payment_method": "PAYMENT_CARD",
    "status": "ACTIVE",
    "term_number": 1,
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z",
    "start_date": "2026-03-07T00:59:52.928Z",
    "cancellation_date": "2026-03-07T00:59:52.928Z",
    "expired_at": "2026-03-07T00:59:52.928Z",
    "next_charge_at": "2026-03-07T00:59:52.928Z",
    "pause_start_at": "2026-03-07T00:59:52.928Z",
    "pause_end_at": "2026-03-07T00:59:52.928Z",
    "trial": true,
    "trial_started_at": "2026-03-07T00:59:52.928Z",
    "trial_ends_at": "2026-03-07T00:59:52.928Z",
    "cancellation_type": "IMMEDIATE",
    "cancellation_reason_code": "PAYMENT_HARD_DECLINE",
    "effective_end_at": "2026-03-07T00:59:52.928Z",
    "cancellation_details": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "decline_code": "text",
      "fraud_case_id": "text",
      "fraud_alert_source": "CB911",
      "cancellation_requested_by": "text",
      "support_case_id": "text",
      "notes": "text",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z"
    },
    "retry_attempt_count": 0,
    "last_retry_at": "2026-03-07T00:59:52.928Z",
    "next_retry_at": "2026-03-07T00:59:52.928Z",
    "subscription_plan": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "website_url": "https://example.com",
      "type": "ONE_TIME",
      "currency": "text",
      "full_price_amount": 1,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "DAYS",
      "trial_price_amount": 1,
      "trial_period_value": 1,
      "trial_period_unit": "DAYS",
      "trial_settlement_interval_hours": 1,
      "retry_strategy_id": 1,
      "settlement_interval_hours": 1,
      "status": "ACTIVE",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z",
      "created_by": "text",
      "active_subscriptions_count": 1
    },
    "product_url": "text",
    "payment_info": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "payment_id": "text",
        "currency": "text",
        "amount": 1,
        "status": "INITIATED",
        "provider": "PRIMER",
        "created_at": "2026-03-07T00:59:52.928Z",
        "decline_code": "text"
      }
    ]
  }
]

Get subscription

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscriptions/{subscriptionId}

Retrieves detailed information about a specific subscription.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionIdstring · uuidRequired

Unique subscription identifier

Responses

200

Subscription retrieved successfully

application/json

idstring · uuidOptional

Subscription ID

subscription_plan_idstring · uuidOptional

Subscription Plan ID

merchant_idstring · uuidOptional

Merchant ID

customer_idstringOptional

Customer identifier

emailstring · emailOptional

Customer email address

payment_methodstring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

term_numberintegerOptional

Current billing term number

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

start_datestring · date-timeOptional

cancellation_datestring · date-timeOptional

expired_atstring · date-timeOptional

next_charge_atstring · date-timeOptional

pause_start_atstring · date-timeOptional

pause_end_atstring · date-timeOptional

trialbooleanOptional

Whether in trial period

trial_started_atstring · date-timeOptional

trial_ends_atstring · date-timeOptional

cancellation_typestring · enumOptional

When to cancel the subscription:

• IMMEDIATE: Cancel immediately
• END_OF_CYCLE: Cancel at the end of current billing period

Possible values:

cancellation_reason_codestring · enumOptionalPossible values:

effective_end_atstring · date-timeOptional

When subscription access ends

retry_attempt_countintegerOptionalDefault: 0

last_retry_atstring · date-timeOptional

next_retry_atstring · date-timeOptional

product_urlstringOptional

Product URL from subscription plan

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

/v1/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

GET /v1/subscriptions/{subscriptionId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "text",
  "email": "[e-mail]",
  "payment_method": "PAYMENT_CARD",
  "status": "ACTIVE",
  "term_number": 1,
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "start_date": "2026-03-07T00:59:52.928Z",
  "cancellation_date": "2026-03-07T00:59:52.928Z",
  "expired_at": "2026-03-07T00:59:52.928Z",
  "next_charge_at": "2026-03-07T00:59:52.928Z",
  "pause_start_at": "2026-03-07T00:59:52.928Z",
  "pause_end_at": "2026-03-07T00:59:52.928Z",
  "trial": true,
  "trial_started_at": "2026-03-07T00:59:52.928Z",
  "trial_ends_at": "2026-03-07T00:59:52.928Z",
  "cancellation_type": "IMMEDIATE",
  "cancellation_reason_code": "PAYMENT_HARD_DECLINE",
  "effective_end_at": "2026-03-07T00:59:52.928Z",
  "cancellation_details": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "decline_code": "text",
    "fraud_case_id": "text",
    "fraud_alert_source": "CB911",
    "cancellation_requested_by": "text",
    "support_case_id": "text",
    "notes": "text",
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z"
  },
  "retry_attempt_count": 0,
  "last_retry_at": "2026-03-07T00:59:52.928Z",
  "next_retry_at": "2026-03-07T00:59:52.928Z",
  "subscription_plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "website_url": "https://example.com",
    "type": "ONE_TIME",
    "currency": "text",
    "full_price_amount": 1,
    "billing_frequency_value": 1,
    "billing_frequency_unit": "DAYS",
    "trial_price_amount": 1,
    "trial_period_value": 1,
    "trial_period_unit": "DAYS",
    "trial_settlement_interval_hours": 1,
    "retry_strategy_id": 1,
    "settlement_interval_hours": 1,
    "status": "ACTIVE",
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z",
    "created_by": "text",
    "active_subscriptions_count": 1
  },
  "product_url": "text",
  "payment_info": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payment_id": "text",
      "currency": "text",
      "amount": 1,
      "status": "INITIATED",
      "provider": "PRIMER",
      "created_at": "2026-03-07T00:59:52.928Z",
      "decline_code": "text"
    }
  ]
}

Search subscriptions

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscriptions/search

Search subscriptions using filters with pagination support.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Responses

200

Search results retrieved successfully

application/json

total_elementsinteger · int64Required

total_pagesintegerRequired

current_pageintegerRequired

page_sizeintegerRequired

has_nextbooleanOptional

has_previousbooleanOptional

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

post

/v1/subscriptions/search

HTTPcURLJavaScriptPython

POST /v1/subscriptions/search HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "filters": [
    {
      "operator": "contains",
      "field": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "size": 10
  },
  "sort": {
    "field": "text",
    "direction": "DESC"
  }
}

{
  "subscriptions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
      "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
      "customer_id": "text",
      "email": "[e-mail]",
      "payment_method": "PAYMENT_CARD",
      "status": "ACTIVE",
      "term_number": 1,
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z",
      "start_date": "2026-03-07T00:59:52.928Z",
      "cancellation_date": "2026-03-07T00:59:52.928Z",
      "expired_at": "2026-03-07T00:59:52.928Z",
      "next_charge_at": "2026-03-07T00:59:52.928Z",
      "pause_start_at": "2026-03-07T00:59:52.928Z",
      "pause_end_at": "2026-03-07T00:59:52.928Z",
      "trial": true,
      "trial_started_at": "2026-03-07T00:59:52.928Z",
      "trial_ends_at": "2026-03-07T00:59:52.928Z",
      "cancellation_type": "IMMEDIATE",
      "cancellation_reason_code": "PAYMENT_HARD_DECLINE",
      "effective_end_at": "2026-03-07T00:59:52.928Z",
      "cancellation_details": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "decline_code": "text",
        "fraud_case_id": "text",
        "fraud_alert_source": "CB911",
        "cancellation_requested_by": "text",
        "support_case_id": "text",
        "notes": "text",
        "created_at": "2026-03-07T00:59:52.928Z",
        "updated_at": "2026-03-07T00:59:52.928Z"
      },
      "retry_attempt_count": 0,
      "last_retry_at": "2026-03-07T00:59:52.928Z",
      "next_retry_at": "2026-03-07T00:59:52.928Z",
      "subscription_plan": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "website_url": "https://example.com",
        "type": "ONE_TIME",
        "currency": "text",
        "full_price_amount": 1,
        "billing_frequency_value": 1,
        "billing_frequency_unit": "DAYS",
        "trial_price_amount": 1,
        "trial_period_value": 1,
        "trial_period_unit": "DAYS",
        "trial_settlement_interval_hours": 1,
        "retry_strategy_id": 1,
        "settlement_interval_hours": 1,
        "status": "ACTIVE",
        "created_at": "2026-03-07T00:59:52.928Z",
        "updated_at": "2026-03-07T00:59:52.928Z",
        "created_by": "text",
        "active_subscriptions_count": 1
      },
      "product_url": "text",
      "payment_info": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "payment_id": "text",
          "currency": "text",
          "amount": 1,
          "status": "INITIATED",
          "provider": "PRIMER",
          "created_at": "2026-03-07T00:59:52.928Z",
          "decline_code": "text"
        }
      ]
    }
  ],
  "total_elements": 1,
  "total_pages": 1,
  "current_page": 1,
  "page_size": 1,
  "has_next": true,
  "has_previous": true
}

Cancel subscription

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscriptions/{subscriptionId}/cancel

Cancels a subscription with the specified cancellation type and reason. Use IMMEDIATE to cancel immediately, or END_OF_CYCLE to cancel at the end of the current billing period.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionIdstring · uuidRequired

Unique subscription identifier

Header parameters

Idempotency-KeystringOptional

Unique key for idempotent cancellation requests

Body

application/json

cancellation_typestring · enumRequired

When to cancel the subscription:

• IMMEDIATE: Cancel immediately
• END_OF_CYCLE: Cancel at the end of current billing period

Possible values:

cancellation_reason_codestring · enumRequiredPossible values:

Responses

201

Subscription cancelled successfully

application/json

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

post

/v1/subscriptions/{subscriptionId}/cancel

HTTPcURLJavaScriptPython

POST /v1/subscriptions/{subscriptionId}/cancel HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "cancellation_type": "IMMEDIATE",
  "cancellation_reason_code": "PAYMENT_HARD_DECLINE",
  "cancellation_details": {
    "decline_code": "text",
    "fraud_case_id": "text",
    "fraud_alert_source": "CB911",
    "requested_by": "text",
    "support_case_id": "text",
    "notes": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "merchant_id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "text",
  "email": "[e-mail]",
  "payment_method": "PAYMENT_CARD",
  "status": "ACTIVE",
  "term_number": 1,
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "start_date": "2026-03-07T00:59:52.928Z",
  "cancellation_date": "2026-03-07T00:59:52.928Z",
  "expired_at": "2026-03-07T00:59:52.928Z",
  "next_charge_at": "2026-03-07T00:59:52.928Z",
  "pause_start_at": "2026-03-07T00:59:52.928Z",
  "pause_end_at": "2026-03-07T00:59:52.928Z",
  "trial": true,
  "trial_started_at": "2026-03-07T00:59:52.928Z",
  "trial_ends_at": "2026-03-07T00:59:52.928Z",
  "cancellation_type": "IMMEDIATE",
  "cancellation_reason_code": "PAYMENT_HARD_DECLINE",
  "effective_end_at": "2026-03-07T00:59:52.928Z",
  "cancellation_details": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "decline_code": "text",
    "fraud_case_id": "text",
    "fraud_alert_source": "CB911",
    "cancellation_requested_by": "text",
    "support_case_id": "text",
    "notes": "text",
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z"
  },
  "retry_attempt_count": 0,
  "last_retry_at": "2026-03-07T00:59:52.928Z",
  "next_retry_at": "2026-03-07T00:59:52.928Z",
  "subscription_plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "website_url": "https://example.com",
    "type": "ONE_TIME",
    "currency": "text",
    "full_price_amount": 1,
    "billing_frequency_value": 1,
    "billing_frequency_unit": "DAYS",
    "trial_price_amount": 1,
    "trial_period_value": 1,
    "trial_period_unit": "DAYS",
    "trial_settlement_interval_hours": 1,
    "retry_strategy_id": 1,
    "settlement_interval_hours": 1,
    "status": "ACTIVE",
    "created_at": "2026-03-07T00:59:52.928Z",
    "updated_at": "2026-03-07T00:59:52.928Z",
    "created_by": "text",
    "active_subscriptions_count": 1
  },
  "product_url": "text",
  "payment_info": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payment_id": "text",
      "currency": "text",
      "amount": 1,
      "status": "INITIATED",
      "provider": "PRIMER",
      "created_at": "2026-03-07T00:59:52.928Z",
      "decline_code": "text"
    }
  ]
}

Create subscription client session

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscriptions/client-sessions

Creates a client session for subscription-based payments. This generates a client token for initializing the Payment Iframe with subscription-specific parameters.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

subscription_plan_idstring · uuidRequired

Subscription plan identifier

customer_idstringRequired

Your unique customer identifier

order_idstringOptional

Your unique order identifier

payment_providerstring · enumOptionalPossible values:

Responses

201

Subscription client session created successfully

application/json

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

post

/v1/subscriptions/client-sessions

HTTPcURLJavaScriptPython

POST /v1/subscriptions/client-sessions HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "text",
  "order_id": "text",
  "customer": {
    "first_name": "text",
    "last_name": "text",
    "email": "[e-mail]"
  },
  "payment_provider": "PRIMER",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "order": {
    "country_code": "US"
  }
}

{
  "client_session_token": "text",
  "client_session_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscription_plan_name": "text",
  "subscription_plan_website_url": "https://example.com",
  "payment_provider": "PRIMER",
  "amount": 1,
  "currency": "text",
  "customer_id": "text",
  "order_id": "text",
  "created_at": "2026-03-07T00:59:52.928Z"
}

List subscription plans

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans

Retrieves a paginated list of subscription plans for your merchant account.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Query parameters

pageintegerOptional

Page number (0-based)

Default: 0

sizeinteger · min: 1 · max: 100Optional

Page size

Default: 10

Responses

200

Subscription plans retrieved successfully

application/json

total_elementsinteger · int64Required

total_pagesintegerRequired

current_pageintegerRequired

page_sizeintegerRequired

has_nextbooleanRequired

has_previousbooleanRequired

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

get

/v1/subscription-plans

HTTPcURLJavaScriptPython

GET /v1/subscription-plans HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "content": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "website_url": "https://example.com",
      "type": "ONE_TIME",
      "currency": "text",
      "full_price_amount": 1,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "DAYS",
      "trial_price_amount": 1,
      "trial_period_value": 1,
      "trial_period_unit": "DAYS",
      "trial_settlement_interval_hours": 1,
      "retry_strategy_id": 1,
      "settlement_interval_hours": 1,
      "status": "ACTIVE",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z",
      "created_by": "text",
      "active_subscriptions_count": 1
    }
  ],
  "total_elements": 1,
  "total_pages": 1,
  "current_page": 1,
  "page_size": 1,
  "has_next": true,
  "has_previous": true
}

Create subscription plan

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans

Creates a new subscription or one-time plan. The request body varies based on the plan type:

• ONE_TIME: Single purchase

• SUBSCRIPTION_NO_TRIAL: Recurring subscription without trial

• SUBSCRIPTION_FREE_TRIAL: Recurring subscription with free trial

• SUBSCRIPTION_PAID_TRIAL: Recurring subscription with paid trial

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

or

or

or

Responses

201

Subscription plan created successfully

application/json

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

post

/v1/subscription-plans

HTTPcURLJavaScriptPython

POST /v1/subscription-plans HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "type": "ONE_TIME",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "currency": "text",
  "full_price_amount": 1,
  "settlement_interval_hours": 1,
  "status": "DRAFT"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "type": "ONE_TIME",
  "currency": "text",
  "full_price_amount": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1,
  "settlement_interval_hours": 1,
  "status": "ACTIVE",
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "created_by": "text",
  "active_subscriptions_count": 1
}

Get subscription plan

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/{subscriptionPlanId}

Retrieves a specific subscription plan by ID.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionPlanIdstring · uuidRequired

Unique subscription plan identifier

Responses

200

Subscription plan retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

website_urlstring · uriOptional

typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

currencystringOptional

full_price_amountnumber · decimalOptional

billing_frequency_valueintegerOptional

billing_frequency_unitstring · enumOptionalPossible values:

trial_price_amountnumber · decimalOptional

trial_period_valueintegerOptional

trial_period_unitstring · enumOptionalPossible values:

trial_settlement_interval_hoursintegerOptional

retry_strategy_idintegerOptional

settlement_interval_hoursintegerOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystringOptional

active_subscriptions_countinteger · int64Optional

Count of active subscriptions

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

/v1/subscription-plans/{subscriptionPlanId}

HTTPcURLJavaScriptPython

GET /v1/subscription-plans/{subscriptionPlanId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "type": "ONE_TIME",
  "currency": "text",
  "full_price_amount": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1,
  "settlement_interval_hours": 1,
  "status": "ACTIVE",
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "created_by": "text",
  "active_subscriptions_count": 1
}

Activate subscription plan

put

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/{subscriptionPlanId}/activate

Changes subscription plan status to ACTIVE. Only DRAFT or DEACTIVATED plans can be activated.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionPlanIdstring · uuidRequired

Unique subscription plan identifier

Body

application/json

objectOptional

Empty request body

Responses

200

Subscription plan activated successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

website_urlstring · uriOptional

typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

currencystringOptional

full_price_amountnumber · decimalOptional

billing_frequency_valueintegerOptional

billing_frequency_unitstring · enumOptionalPossible values:

trial_price_amountnumber · decimalOptional

trial_period_valueintegerOptional

trial_period_unitstring · enumOptionalPossible values:

trial_settlement_interval_hoursintegerOptional

retry_strategy_idintegerOptional

settlement_interval_hoursintegerOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystringOptional

active_subscriptions_countinteger · int64Optional

Count of active subscriptions

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

put

/v1/subscription-plans/{subscriptionPlanId}/activate

HTTPcURLJavaScriptPython

PUT /v1/subscription-plans/{subscriptionPlanId}/activate HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "type": "ONE_TIME",
  "currency": "text",
  "full_price_amount": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1,
  "settlement_interval_hours": 1,
  "status": "ACTIVE",
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "created_by": "text",
  "active_subscriptions_count": 1
}

Delete subscription plan

delete

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/{subscriptionPlanId}

Permanently deletes a subscription plan. Only plans with no active subscriptions can be deleted.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionPlanIdstring · uuidRequired

Unique subscription plan identifier

Responses

204

Subscription plan deleted successfully

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

delete

/v1/subscription-plans/{subscriptionPlanId}

HTTPcURLJavaScriptPython

DELETE /v1/subscription-plans/{subscriptionPlanId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

No content

Update subscription plan

put

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/{subscriptionPlanId}

Updates an existing subscription plan.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionPlanIdstring · uuidRequired

Unique subscription plan identifier

Body

application/json

typestring · enumRequired

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

namestring · max: 255Optional

descriptionstring · max: 1000Optional

website_urlstring · uriOptional

currencystringOptionalPattern: ^[A-Z]{3}$

full_price_amountnumber · decimalOptional

settlement_interval_hoursintegerOptional

billing_frequency_valueinteger · min: 1 · max: 999Optional

billing_frequency_unitstring · enumOptionalPossible values:

trial_price_amountnumber · decimalOptional

trial_period_valueinteger · min: 1 · max: 999Optional

trial_period_unitstring · enumOptionalPossible values:

trial_settlement_interval_hoursinteger · max: 239Optional

retry_strategy_idintegerOptional

Responses

200

Subscription plan updated successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

website_urlstring · uriOptional

typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

currencystringOptional

full_price_amountnumber · decimalOptional

billing_frequency_valueintegerOptional

billing_frequency_unitstring · enumOptionalPossible values:

trial_price_amountnumber · decimalOptional

trial_period_valueintegerOptional

trial_period_unitstring · enumOptionalPossible values:

trial_settlement_interval_hoursintegerOptional

retry_strategy_idintegerOptional

settlement_interval_hoursintegerOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystringOptional

active_subscriptions_countinteger · int64Optional

Count of active subscriptions

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

put

/v1/subscription-plans/{subscriptionPlanId}

HTTPcURLJavaScriptPython

PUT /v1/subscription-plans/{subscriptionPlanId} HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "type": "ONE_TIME",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "currency": "text",
  "full_price_amount": 1,
  "settlement_interval_hours": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "type": "ONE_TIME",
  "currency": "text",
  "full_price_amount": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1,
  "settlement_interval_hours": 1,
  "status": "ACTIVE",
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "created_by": "text",
  "active_subscriptions_count": 1
}

Deactivate subscription plan

put

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/{subscriptionPlanId}/deactivate

Changes subscription plan status to DEACTIVATED. Only ACTIVE plans can be deactivated.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Path parameters

subscriptionPlanIdstring · uuidRequired

Unique subscription plan identifier

Body

application/json

objectOptional

Empty request body

Responses

200

Subscription plan deactivated successfully

application/json

idstring · uuidOptional

namestringOptional

descriptionstringOptional

website_urlstring · uriOptional

typestring · enumOptional

Plan type:

• ONE_TIME: Single purchase
• SUBSCRIPTION_NO_TRIAL: Recurring without trial
• SUBSCRIPTION_FREE_TRIAL: Recurring with free trial
• SUBSCRIPTION_PAID_TRIAL: Recurring with paid trial

Possible values:

currencystringOptional

full_price_amountnumber · decimalOptional

billing_frequency_valueintegerOptional

billing_frequency_unitstring · enumOptionalPossible values:

trial_price_amountnumber · decimalOptional

trial_period_valueintegerOptional

trial_period_unitstring · enumOptionalPossible values:

trial_settlement_interval_hoursintegerOptional

retry_strategy_idintegerOptional

settlement_interval_hoursintegerOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystringOptional

active_subscriptions_countinteger · int64Optional

Count of active subscriptions

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

put

/v1/subscription-plans/{subscriptionPlanId}/deactivate

HTTPcURLJavaScriptPython

PUT /v1/subscription-plans/{subscriptionPlanId}/deactivate HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "website_url": "https://example.com",
  "type": "ONE_TIME",
  "currency": "text",
  "full_price_amount": 1,
  "billing_frequency_value": 1,
  "billing_frequency_unit": "DAYS",
  "trial_price_amount": 1,
  "trial_period_value": 1,
  "trial_period_unit": "DAYS",
  "trial_settlement_interval_hours": 1,
  "retry_strategy_id": 1,
  "settlement_interval_hours": 1,
  "status": "ACTIVE",
  "created_at": "2026-03-07T00:59:52.928Z",
  "updated_at": "2026-03-07T00:59:52.928Z",
  "created_by": "text",
  "active_subscriptions_count": 1
}

Search subscription plans

post

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/subscription-plans/search

Search subscription plans using filters with pagination support.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Body

application/json

Responses

200

Search results retrieved successfully

application/json

total_elementsinteger · int64Required

total_pagesintegerRequired

current_pageintegerRequired

page_sizeintegerRequired

has_nextbooleanOptional

has_previousbooleanOptional

400

Invalid request parameters

application/json

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

post

/v1/subscription-plans/search

HTTPcURLJavaScriptPython

POST /v1/subscription-plans/search HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "filters": [
    {
      "operator": "contains",
      "field": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "size": 10
  },
  "sort": {
    "field": "text",
    "direction": "DESC"
  }
}

{
  "subscription_plans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "website_url": "https://example.com",
      "type": "ONE_TIME",
      "currency": "text",
      "full_price_amount": 1,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "DAYS",
      "trial_price_amount": 1,
      "trial_period_value": 1,
      "trial_period_unit": "DAYS",
      "trial_settlement_interval_hours": 1,
      "retry_strategy_id": 1,
      "settlement_interval_hours": 1,
      "status": "ACTIVE",
      "created_at": "2026-03-07T00:59:52.928Z",
      "updated_at": "2026-03-07T00:59:52.928Z",
      "created_by": "text",
      "active_subscriptions_count": 1
    }
  ],
  "total_elements": 1,
  "total_pages": 1,
  "current_page": 1,
  "page_size": 1,
  "has_next": true,
  "has_previous": true
}

List retry strategies

get

https://api.flintn.comhttps://api.sandbox.flintn.com

/v1/retry-strategies

Retrieves available retry strategies for handling failed subscription payments.

Authorizations

ApiKeyAuth

X-Api-KeystringRequired

API key for authentication. Format: pk_live_* (production) or pk_test_* (sandbox). Obtain keys at hub.flintn.com/developers.

Responses

200

Retry strategies retrieved successfully

application/json

valueintegerRequired

Retry strategy ID

labelstringRequired

Display label

401

Invalid or missing API key

application/json

403

API key lacks required permission for this operation

application/json

500

Internal server error

application/json

get

/v1/retry-strategies

HTTPcURLJavaScriptPython

GET /v1/retry-strategies HTTP/1.1
Host: api.flintn.com
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "value": 1,
    "label": "text"
  }
]

Subscription Activated

Sent when a new subscription is activated after successful initial payment.

Your endpoint should respond with a 2xx status code to acknowledge receipt. If we don't receive a successful response, we'll retry the webhook up to 5 times with exponential backoff.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "6fe45cc8-503c-4d23-a9fd-724a206b3f7a",
  "event_type": "SUBSCRIPTION_ACTIVATED",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.0",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "subscription_plan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "customer_id": "cust_123456",
    "email": "[e-mail]",
    "status": "ACTIVE",
    "term_number": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "start_date": "2024-01-15T10:30:00Z",
    "next_charge_at": "2024-02-15T10:30:00Z",
    "subscription_plan": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Premium Monthly",
      "currency": "USD",
      "full_price_amount": 29.99,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "MONTHS",
      "type": "SUBSCRIPTION_NO_TRIAL"
    },
    "payment_info": [
      {
        "payment_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "currency": "USD",
        "amount": 29.99,
        "status": "AUTHORIZED",
        "provider": "PRIMER",
        "created_at": "2024-01-15T10:30:00Z"
      }
    ]
  }
}

Subscription Renewed

Sent when a subscription successfully renews for a new billing period.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "7af56dd9-614d-5e34-b0ae-835b317c4f8b",
  "event_type": "SUBSCRIPTION_RENEWED",
  "timestamp": "2024-02-15T10:30:00Z",
  "version": "1.0",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "subscription_plan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "customer_id": "cust_123456",
    "email": "[e-mail]",
    "status": "ACTIVE",
    "term_number": 2,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-15T10:30:00Z",
    "start_date": "2024-01-15T10:30:00Z",
    "next_charge_at": "2024-03-15T10:30:00Z",
    "subscription_plan": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Premium Monthly",
      "currency": "USD",
      "full_price_amount": 29.99,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "MONTHS",
      "type": "SUBSCRIPTION_NO_TRIAL"
    },
    "payment_info": [
      {
        "payment_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "currency": "USD",
        "amount": 29.99,
        "status": "AUTHORIZED",
        "provider": "PRIMER",
        "created_at": "2024-02-15T10:30:00Z"
      }
    ]
  }
}

Subscription Cancelled

Sent when a subscription is cancelled immediately.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "8bg67ee0-725e-6f45-c1bf-946c428d5g9c",
  "event_type": "SUBSCRIPTION_CANCELLED",
  "timestamp": "2024-01-20T15:00:00Z",
  "version": "1.0",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "subscription_plan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "customer_id": "cust_123456",
    "email": "[e-mail]",
    "status": "CANCELLED",
    "term_number": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T15:00:00Z",
    "start_date": "2024-01-15T10:30:00Z",
    "cancellation_date": "2024-01-20T15:00:00Z",
    "cancellation_type": "IMMEDIATE",
    "cancellation_reason_code": "CLIENT_REQUESTED"
  }
}

Subscription Expired

Sent when a subscription expires (after failed retries or end of term).

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "0di89gg2-947g-8h67-e3dh-b68e640f7i1e",
  "event_type": "SUBSCRIPTION_EXPIRED",
  "timestamp": "2024-02-15T10:30:00Z",
  "version": "1.0",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "subscription_plan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "customer_id": "cust_123456",
    "email": "[e-mail]",
    "status": "EXPIRED",
    "term_number": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-15T10:30:00Z",
    "start_date": "2024-01-15T10:30:00Z",
    "expired_at": "2024-02-15T10:30:00Z",
    "cancellation_reason_code": "PAYMENT_DECLINED_RETRY_EXHAUSTED",
    "last_retry_at": "2024-02-14T10:30:00Z"
  }
}

Subscription Billing Retry

Sent when a billing retry attempt is made for a failed payment.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "1ej90hh3-a58h-9i78-f4ei-c79f751g8j2f",
  "event_type": "SUBSCRIPTION_BILLING_RETRY",
  "timestamp": "2024-02-22T10:30:00Z",
  "version": "1.0",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "subscription_plan_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "customer_id": "cust_123456",
    "email": "[e-mail]",
    "status": "BILLING_RETRY",
    "term_number": 2,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-22T10:30:00Z",
    "start_date": "2024-01-15T10:30:00Z",
    "retry_attempt_count": 2,
    "last_retry_at": "2024-02-22T10:30:00Z",
    "next_retry_at": "2024-03-01T10:30:00Z",
    "subscription_plan": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Premium Monthly",
      "currency": "USD",
      "full_price_amount": 29.99,
      "billing_frequency_value": 1,
      "billing_frequency_unit": "MONTHS",
      "type": "SUBSCRIPTION_NO_TRIAL"
    },
    "payment_info": [
      {
        "payment_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
        "currency": "USD",
        "amount": 29.99,
        "status": "DECLINED",
        "provider": "PRIMER",
        "created_at": "2024-02-22T10:30:00Z",
        "decline_code": "INSUFFICIENT_FUNDS"
      }
    ]
  }
}

Transaction Pending

Sent when a transaction is created and pending processing.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "2fk01ii4-b69i-0j89-g5fj-d80g862h9k3g",
  "event_type": "TRANSACTION_PENDING",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "PENDING",
    "history": [],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    }
  }
}

Transaction Authorized

Sent when a transaction is successfully authorized.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "3gl12jj5-c70j-1k90-h6gk-e91h973i0l4h",
  "event_type": "TRANSACTION_AUTHORIZED",
  "timestamp": "2024-01-15T10:30:05Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "AUTHORIZED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "AUTHORIZED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:05Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    },
    "card_data": {
      "card_brand": "VISA",
      "card_last_4": "4242",
      "card_funding_type": "CREDIT"
    },
    "risk_data": {
      "avs_result": "Y",
      "cvc_result": "M"
    },
    "network_data": {
      "authorization_code": "AUTH123"
    }
  }
}

Transaction Declined

Sent when a transaction is declined.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "4hm23kk6-d81k-2l01-i7hl-f02i084j1m5i",
  "event_type": "TRANSACTION_DECLINED",
  "timestamp": "2024-01-15T10:30:05Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "DECLINED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "DECLINED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:05Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    },
    "card_data": {
      "card_brand": "VISA",
      "card_last_4": "4242"
    },
    "risk_data": {
      "decline_code": "INSUFFICIENT_FUNDS"
    }
  }
}

Transaction Failed

Sent when a transaction fails to process (not declined, but error).

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "5in34ll7-e92l-3m12-j8im-g13j195k2n6j",
  "event_type": "TRANSACTION_FAILED",
  "timestamp": "2024-01-15T10:30:05Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "FAILED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "FAILED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:05Z",
    "customer_data": {
      "customer_id": "cust_123456"
    }
  }
}

Transaction Voided

Sent when a transaction is voided.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "6jo45mm8-f03m-4n23-k9jn-h24k206l3o7k",
  "event_type": "TRANSACTION_VOIDED",
  "timestamp": "2024-01-15T12:00:00Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "VOIDED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "AUTHORIZED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-15T12:00:00Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "VOIDED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T12:00:00Z",
    "customer_data": {
      "customer_id": "cust_123456"
    }
  }
}

Transaction Settled

Sent when a transaction is settled and funds transferred.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "7kp56nn9-g14n-5o34-l0ko-i35l317m4p8l",
  "event_type": "TRANSACTION_SETTLED",
  "timestamp": "2024-01-16T08:00:00Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "status": "SETTLED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "AUTHORIZED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-16T08:00:00Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "SETTLED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-16T08:00:00Z",
    "settled_at": "2024-01-16T08:00:00Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    },
    "card_data": {
      "card_brand": "VISA",
      "card_last_4": "4242",
      "card_funding_type": "CREDIT"
    }
  }
}

Transaction Refunded

Sent when a transaction is fully refunded.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "8lq67oo0-h25o-6p45-m1lp-j46m428n5q9m",
  "event_type": "TRANSACTION_REFUNDED",
  "timestamp": "2024-01-20T14:00:00Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "refunded_amount": 29.99,
    "status": "REFUNDED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "AUTHORIZED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-16T08:00:00Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "SETTLED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-20T14:00:00Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "REFUNDED",
        "processor_transaction_id": "proc_refund_456",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:00:00Z",
    "settled_at": "2024-01-16T08:00:00Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    }
  }
}

Transaction Partially Refunded

Sent when a transaction is partially refunded.

Your endpoint should respond with a 2xx status code to acknowledge receipt.

Payload

application/json

Responses

200

Webhook received successfully

No content

Payload

{
  "event_id": "9mr78pp1-i36p-7q56-n2mq-k57n539o6r0n",
  "event_type": "TRANSACTION_PARTIALLY_REFUNDED",
  "timestamp": "2024-01-20T14:00:00Z",
  "version": "1.0",
  "data": {
    "id": "1562d729-0415-4750-a333-3669f49b643a",
    "payment_id": "b282852c-1421-4ef9-bce6-28a3d25216d6",
    "merchant_id": "5f5094c6-c8cb-4f15-8b0e-8b5b0b1bea94",
    "amount": 29.99,
    "currency": "USD",
    "refunded_amount": 10,
    "status": "PARTIALLY_REFUNDED",
    "history": [
      {
        "created_at": "2024-01-15T10:30:05Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "AUTHORIZED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-16T08:00:00Z",
        "amount": 29.99,
        "currency": "USD",
        "status": "SETTLED",
        "processor_transaction_id": "proc_txn_123",
        "processor": "PRIMER"
      },
      {
        "created_at": "2024-01-20T14:00:00Z",
        "amount": 10,
        "currency": "USD",
        "status": "PARTIALLY_REFUNDED",
        "processor_transaction_id": "proc_refund_789",
        "processor": "PRIMER"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:00:00Z",
    "settled_at": "2024-01-16T08:00:00Z",
    "customer_data": {
      "customer_id": "cust_123456",
      "customer_email": "[e-mail]"
    }
  }
}