Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Team Payments

Update Stripe Connect event routing

Configure whether Stripe Connect applies to every team event or only selected events.

patch/teams/{key}/payment/gateway

Path parameters

keystring required

Team identifier (ID or slug)

Request body

scope'TEAM' | 'EVENTS' required

Stripe Connect event routing scope. TEAM routes every team event through Stripe Connect. EVENTS routes selected events only.

eventIdsstring[]

Event IDs routed through Stripe Connect when scope is EVENTS. Omit or pass an empty array to keep Stripe Connect disabled for all events in EVENTS mode.

Example request

{
  "scope": "EVENTS"
}

Response

OK

idstring required

Unique identifier for the team organization

createdAtstring date-time required

Timestamp in ISO 8601 format when the team was created

updatedAtstring date-time required

Timestamp in ISO 8601 format when the team was last updated

namestring required

Display name of the team organization. Must be between 3 and 30 characters

slugstring required

URL-friendly slug for the team organization. Must be unique within tenant and between 3 and 30 characters

supportEmailstring email

Support email address for customer inquiries. Used as reply-to address in order confirmation emails

publicBaseUrlstring uri

Optional public website base URL for team-owned event and order links. When present, it overrides the tenant public base URL.

metadataobject

Flexible key-value metadata storage for custom configuration. Similar to Stripe's metadata API. Maximum 50 keys, key names up to 40 characters, values up to 500 characters.

approval'PENDING' | 'APPROVED' | 'REJECTED' required

Approval status of the team. PENDING: awaiting review, APPROVED: can create promoters/venues/events, REJECTED: cannot operate

deletedAtstring date-time

Timestamp in ISO 8601 format when the team was soft deleted. Only present for deleted teams.

tenantIdstring required

Tenant ID for multi-tenant isolation

isAdminboolean

Whether this team is the admin team for the tenant

Example response

{
  "publicBaseUrl": "https://sash.net.au",
  "image": {
    "src": "https://assets.session.services/my-image.jpg",
    "alt": "My Image",
    "width": 1080,
    "height": 1080
  }
}