Get a payout by ID

bearerAuth

Sulu

Introduction

An API platform for humans and AI agents.

Quickstart

The command center for all your API needs.

Developer Dashboard

API Documentation

Credits

Producer Dashboard

Listings

Organization Pages

Payouts

Fixed, liquid, and everything in between.

Prices

Community

Blog

API Reference

Support

Authentication

Organizations and Users

Wallets

Products

Billable Metrics

Plans and Prices

Customers and Subscriptions

Usage Events

Create a new merchant organization. A merchant organization represents a business entity that sells one or more products. Merchant organizations own resources such as `products`, `prices`, `customers`, `subscriptions`, etc.

Create a new merchant organization

Get merchant organization by ID

Delete a merchant organization. This will delete all resources associated with the merchant organization. At the moment this endpoint can only be accessed by Sulu admins.

Delete merchant organization

Update merchant organization

Create a new consumer. A consumer represents an entity that consumes a `Merchant`'s `Product`. Consumers can have one or more `subscriptions`, monitor wallet balances, analyze usage, and manage their subscriptions from a single entrypoint.

Create consumer

Get consumer

Update consumer

List customers of a merchant organization

Create a new customer for a merchant organization. This endpoint is currently only used by the Sulu platform as part of the subscription flow.

Create new customer

Get customer details

Create an authorization session for a customer. An authorization session is used to create customer and subscription resources for a consumer. The URL generated can be sent to the consumer for them to complete the subscription process.

Create authorization session for customer

Fetch the authorization session

Update authorization session

List users

Create a new user. A user is an entity that has access to an Organization's resources. Every action is carried out by a user. At the moment this endpoint can only be accessed by Sulu admins.

Create a new user

Get user by ID

Delete a user by ID. This endpoint is currently only used by the Sulu platform as part of the subscription flow.

Delete user

Update user

List user's API keys

Create API key for user

Delete user API key

Create a new principal for a user. A principal links a user to an organization and a set of roles. Every action is carried out by a principal. At the moment this endpoint can only be accessed by Sulu admins.

Create a new principal for a user

List products

Create a new product

Get product by ID

Delete product

Update product

List billable metrics

Create a new billable metric for a merchant organization. A `Billable Metric` represents a metric that can be used to measure the usage of a `Product`. It contains information about the metric, such as its name, description, and units.

Create a new billable metric

Get billable metric by ID

Delete billable metric

Update billable metric

List plans

Create a new plan

Get plan by ID

Delete plan

Update plan

List prices

Create a new price

Get price by ID

Delete price

Update price

List subscriptions

Creates a subscription for a customer. The customer must already exist in the system. Currently this endpoint is only available for Sulu admins as part of the subscription authorization flow.

Create a subscription

Get a subscription

Update a subscription

List usage events

Creates a usage event. The idempotencyKey is used to ensure the event is processed only once by downstream consumers, even if the same event is submitted multiple times. Duplicate submissions will be accepted and return the same response.

Create a usage event

Get a usage event by ID

Creates multiple usage events in a single request. The idempotencyKey for each event is used to ensure the event is processed only once by downstream consumers, even if the same event is submitted multiple times. Duplicate submissions will be accepted and return the same response.

Batch create usage events

Get active entitlements for a customer

List wallets owned by an organization

Create a new wallet

Get wallet by ID

List topups for a wallet

Create a new topup for a wallet

Get a specific topup by ID

Get a list of payouts

Create a new payout

Retrieve a list of available payout methods.

Get a list of payout methods

Update a payout

List all external bank accounts for an organization.

List external bank accounts

Create a new external bank account for an organization.

Create a new external bank account

Retrieve details of a specific external bank account.

Get an external bank account

Delete an external bank account

Update details of a specific external bank account.

Update an external bank account

Walkthrough

Sulu Hub Gateway

API Reference

Get a payout by ID

Authorizations

Path Parameters

Response