@whooshbang/contracts 2.0.0-rc.6 → 2.0.0-rc.8

package/dist/generated/whooshbang-v1.d.ts

@@ -5,15 +5,15 @@
 /**
  * Public request, resource, summary, and Problem Details models for the WhooshBang V1 REST API.
  */
-export type WhooshBangV1ContractDocument = OrganizationProjection | CloseOrganizationRequest | OrganizationClosureResult | CreateProjectRequest | Project | UpdateProjectRequest | PrivacyMode | ProjectCollection | RecipientCopyOverrideCollection | UpdateRecipientCopyOverrideRequest | CreateApiCredentialRequest | RotateApiCredentialRequest | ApiCredential | ApiCredentialCollection | ApiCredentialSecretReveal | ApiCredentialRotation | CreateOrganizationCredentialRequest | RotateOrganizationCredentialRequest | OrganizationCredential | OrganizationCredentialCollection | OrganizationCredentialSecretReveal | OrganizationCredentialRotation | CreateCustomerEndpointRequest | CustomerEndpoint | CustomerEndpointCollection | CustomerEndpointMutationResult | CustomerEndpointAttemptCollection | CustomerEndpointVerificationChallenge | CreateSubscriptionLinkRequest | SubscriptionLink | CreateMessageRequest | Message | Problem | IdempotencyKey | ProviderCapabilitiesCollection | ProviderInstallationCollection | EmailDomainCollection | CreateEmailDomainRequest | CreateEmailBindingImportRequest | EmailBindingImportJob | ConnectionProviderCollection | ChannelConnection | ChannelConnectionCollection | CreateChannelConnectionRequest | UpdateChannelConnectionRequest | RotateChannelConnectionCredentialRequest | NotifierConnectionCollection | AttachNotifierConnectionRequest | ConnectionTest | ConnectionTestCollection | CreateConnectionTestRequest | CustomerApplicationManifest | ProjectRecipientExperience | UpdateProjectRecipientExperienceRequest | RecipientBrandLogoUpload | NotificationImageAsset | EnvironmentRecipientExperience | UpdateEnvironmentRecipientExperienceRequest | SubscriberChannelSettings | AcknowledgeEmailRemediationRequest | CreateRecipientSessionRequest | CreateRecipientSessionResponse | RecipientSession | CreateProviderHandoffRequest | ProviderHandoff | RecipientHandoffCompletion | SetPreferredBindingRequest | PreferredBinding | CreateSubscriberRequest | UpdateSubscriberRequest | SubscriberCollection | Subscriber | SubscriberDataExport | CreateSubscriberGroupRequest | SubscriberGroup | SubscriberGroupCollection | SubscriberGroupMembership | SubscriberGroupMembershipCollection | CreateGroupBroadcastRequest | GroupBroadcast | AssertEmailConsentRequest | BindingSummary | UsageReport | MessageListEntry | MessageListPage | MessageDeliveryTimelineEntry | RetainedMessageContent | MessageDeliveryHistory | InteractionTimelineEntry | InteractionTimeline | UpdateEmailSenderRequest | CustomerEventDeliveryAttempt | CustomerEventDeliveryHistory | DeliveryHolds | MachineClientOperations | MachineClientOperationsList | RecipientCopyCatalogue | MessageNotificationImage | BillingAccount | CreateWalletCheckoutRequest | WalletCheckout | ReconcileWalletCheckoutResult | BillingEntitlements | CreateSubscriptionCheckoutRequest | SubscriptionCheckout | ReconcileSubscriptionCheckoutResult | ProjectAttribution | UpdateProjectAttributionRequest | BillingPortalSession | BillingProjectSlots | AssignBillingProjectSlotsRequest | UpdateAutoTopUpSettingsRequest | AutoTopUpSettings | AutoTopUpSetup | ReconcileAutoTopUpSetupResult | SubscriptionChange | ConfirmSubscriptionChangeRequest;
+export type WhooshBangV1ContractDocument = OrganizationProjection | Teammate | TeammateCollection | TeammateAccessRequest | InviteTeammateRequest | CloseOrganizationRequest | OrganizationClosureResult | CreateProjectRequest | Project | UpdateProjectRequest | PrivacyMode | ProjectCollection | RecipientCopyOverrideCollection | UpdateRecipientCopyOverrideRequest | CreateApiCredentialRequest | RotateApiCredentialRequest | ApiCredential | ApiCredentialCollection | ApiCredentialSecretReveal | ApiCredentialRotation | CreateOrganizationCredentialRequest | RotateOrganizationCredentialRequest | OrganizationCredential | OrganizationCredentialCollection | OrganizationCredentialSecretReveal | OrganizationCredentialRotation | CreateCustomerEndpointRequest | CustomerEndpoint | CustomerEndpointCollection | CustomerEndpointMutationResult | CustomerEndpointAttemptCollection | CustomerEndpointVerificationChallenge | CreateSubscriptionLinkRequest | SubscriptionLink | CreateMessageRequest | Message | Problem | IdempotencyKey | ProviderCapabilitiesCollection | ProviderInstallationCollection | EmailDomainCollection | CreateEmailDomainRequest | CreateEmailBindingImportRequest | EmailBindingImportJob | ConnectionProviderCollection | ChannelConnection | ChannelConnectionCollection | CreateChannelConnectionRequest | UpdateChannelConnectionRequest | RotateChannelConnectionCredentialRequest | NotifierConnectionCollection | AttachNotifierConnectionRequest | ConnectionTest | ConnectionTestCollection | CreateConnectionTestRequest | CustomerApplicationManifest | ProjectRecipientExperience | UpdateProjectRecipientExperienceRequest | RecipientBrandLogoUpload | NotificationImageAsset | EnvironmentRecipientExperience | UpdateEnvironmentRecipientExperienceRequest | SubscriberChannelSettings | AcknowledgeEmailRemediationRequest | CreateRecipientSessionRequest | CreateRecipientSessionResponse | RecipientSession | CreateProviderHandoffRequest | ProviderHandoff | RecipientHandoffCompletion | SetPreferredBindingRequest | PreferredBinding | CreateSubscriberRequest | UpdateSubscriberRequest | SubscriberCollection | Subscriber | SubscriberDataExport | CreateSubscriberGroupRequest | SubscriberGroup | SubscriberGroupCollection | SubscriberGroupMembership | SubscriberGroupMembershipCollection | CreateGroupBroadcastRequest | GroupBroadcast | AssertEmailConsentRequest | BindingSummary | UsageReport | MessageListEntry | MessageListPage | MessageDeliveryTimelineEntry | RetainedMessageContent | MessageDeliveryHistory | InteractionTimelineEntry | InteractionTimeline | UpdateEmailSenderRequest | CustomerEventDeliveryAttempt | CustomerEventDeliveryHistory | DeliveryHolds | MachineClientOperations | MachineClientOperationsList | RecipientCopyCatalogue | MessageNotificationImage | BillingAccount | BillingCard | CardSetup | CreateCreditPurchaseRequest | CreditPurchase | BillingInvoice | BillingInvoiceCollection | UpdateBillingReceiptEmailRequest | BillingEntitlements | SubscriptionSelection1 | ProjectAttribution | UpdateProjectAttributionRequest | BillingProjectSlots | AssignBillingProjectSlotsRequest | UpdateAutoTopUpSettingsRequest | AutoTopUpSettings | SubscriptionChange | ConfirmSubscriptionChangeRequest;
 /**
  * An opaque identifier. Its shape, ordering, and embedded content are not public promises.
  */
 export type OpaqueIdentifier = string;
 /**
- * The stable WhooshBang authorization role projected from the current Clerk organization membership.
+ * The person's WhooshBang role in the organization. `admin` does everything, including billing, API keys and teammates. `member` runs the projects they were given: channels, subscribers, messages and project settings. `messenger` sends messages and reads replies in the projects they were given. Clients must tolerate roles added later.
  */
-export type OrganizationRole = "admin" | "member";
+export type OrganizationRole = "admin" | "member" | "messenger";
 /**
  * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
  */
@@ -22,6 +22,26 @@ export type Timestamp = string;
  * A safe public identifier used to correlate protected service diagnostics.
  */
 export type DiagnosticId = string;
+/**
+ * `active` has joined. `invited` has an invitation they have not accepted.
+ */
+export type TeammateStatus = "active" | "invited";
+/**
+ * A 1-based page number. Present on a response only when the request addressed the list by page rather than by cursor: a cursor walk cannot know which page it is on. What is bounded is the row a page starts at, not the page number: a request whose first row would be past 50,000 — the deepest row any published list ceiling reaches — is refused as `request_invalid`. Bounding the page number instead would make the last rows of a large list unreachable at a small page size, which is exactly when a person is paging through one.
+ */
+export type ListPageNumber = number;
+/**
+ * The page size that produced `items`, echoed so a caller that sent no `limit` can still divide `total` into pages without knowing the server default.
+ */
+export type ListPageSize = number;
+/**
+ * How many records the list holds in total, not only on this page. Counted while the page was read, so a write landing between the count and the page can leave it a record or two out of step with `items`. That is noise on an inspection surface; it never changes which records a page addresses.
+ */
+export type ListTotal = number;
+/**
+ * Exactly one mailbox: an unquoted ASCII dot-atom local part plus a canonical lower-case IDNA domain. The comparison key preserves local-part bytes and case and lower-cases only the domain; dot, plus-tag, alias and provider equivalence are never inferred.
+ */
+export type EmailAddress = string;
 /**
  * A provider that can back a Channel Connection. A member can be frozen before its adapter exists; deployments advertise only providers they can execute.
  */
@@ -38,18 +58,6 @@ export type Environment = "test" | "live";
  * Project profile collection policy. standard (the default for new projects) permits messenger profile data, including the name a subscriber's channel gives; minimal keeps recipient language only; private retains delivery routing and the customer-supplied subscriber identifier, with no profile data. Lowering collection erases existing fields the new mode disallows.
  */
 export type PrivacyMode = "minimal" | "standard" | "private";
-/**
- * A 1-based page number. Present on a response only when the request addressed the list by page rather than by cursor: a cursor walk cannot know which page it is on. What is bounded is the row a page starts at, not the page number: a request whose first row would be past 50,000 — the deepest row any published list ceiling reaches — is refused as `request_invalid`. Bounding the page number instead would make the last rows of a large list unreachable at a small page size, which is exactly when a person is paging through one.
- */
-export type ListPageNumber = number;
-/**
- * The page size that produced `items`, echoed so a caller that sent no `limit` can still divide `total` into pages without knowing the server default.
- */
-export type ListPageSize = number;
-/**
- * How many records the list holds in total, not only on this page. Counted while the page was read, so a write landing between the count and the page can leave it a record or two out of step with `items`. That is noise on an inspection surface; it never changes which records a page addresses.
- */
-export type ListTotal = number;
 /**
  * Every recipient-facing text is customizable (owner decision 2026-09-30, FXO-2739). Labels do not change the actions or capability semantics of recipient controls.
  */
@@ -326,7 +334,7 @@ export type CreateSubscriptionLinkRequest = {
      */
     connection_id?: string;
     /**
-     * The exact recipient address for a server-initiated email verification. It is accepted only when the selected channel is email, stored encrypted, and does not assert consent. Omit it when the recipient will enter the address on the hosted page.
+     * Exactly one mailbox: an unquoted ASCII dot-atom local part plus a canonical lower-case IDNA domain. The comparison key preserves local-part bytes and case and lower-cases only the domain; dot, plus-tag, alias and provider equivalence are never inferred.
      */
     address?: string;
     /**
@@ -470,8 +478,52 @@ export type BindingSummary = {
         };
         domain_id: OpaqueIdentifier;
     };
+} | {
+    id: OpaqueIdentifier;
+    project_id: OpaqueIdentifier;
+    environment: Environment;
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    channel: "email";
+    connection_id: OpaqueIdentifier;
+    status: "active" | "paused" | "revoked";
+    /**
+     * Exactly one mailbox: an unquoted ASCII dot-atom local part plus a canonical lower-case IDNA domain. The comparison key preserves local-part bytes and case and lower-cases only the domain; dot, plus-tag, alias and provider equivalence are never inferred.
+     */
+    address: string;
+    basis: "service";
+    service: {
+        source: string;
+        asserted_at: Timestamp;
+        asserted_by: {
+            kind: "credential" | "grant" | "session";
+            id: OpaqueIdentifier;
+        };
+        domain_id: OpaqueIdentifier;
+        relationship_started_at: Timestamp;
+    };
+} | {
+    id: OpaqueIdentifier;
+    project_id: OpaqueIdentifier;
+    environment: Environment;
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    channel: "email";
+    connection_id: OpaqueIdentifier;
+    status: "active" | "paused" | "revoked";
+    basis: "service";
+    service: {
+        source: string;
+        asserted_at: Timestamp;
+        asserted_by: {
+            kind: "credential" | "grant" | "session";
+            id: OpaqueIdentifier;
+        };
+        domain_id: OpaqueIdentifier;
+        relationship_started_at: Timestamp;
+    };
 };
-export type ProblemCode = "authentication_required" | "credential_invalid" | "scope_forbidden" | "environment_mismatch" | "idempotency_key_required" | "idempotency_conflict" | "privacy_operation_in_progress" | "project_slug_conflict" | "request_invalid" | "replay_unavailable" | "subscriber_unbound" | "subscriber_not_connected" | "recipient_configuration_invalid" | "recipient_origin_forbidden" | "return_destination_not_found" | "recipient_capability_invalid" | "recipient_handoff_invalid" | "preferred_binding_conflict" | "preferred_binding_unavailable" | "subscriber_conflict" | "subscriber_group_conflict" | "subscriber_group_archived" | "resource_not_found" | "resource_expired" | "cancellation_too_late" | "credential_organization_mismatch" | "endpoint_rotation_conflict" | "rate_limited" | "provider_retryable" | "provider_terminal" | "provider_outcome_unknown" | "internal_error";
+export type ProblemCode = "authentication_required" | "credential_invalid" | "scope_forbidden" | "environment_mismatch" | "idempotency_key_required" | "idempotency_conflict" | "privacy_operation_in_progress" | "project_slug_conflict" | "request_invalid" | "replay_unavailable" | "subscriber_unbound" | "subscriber_not_connected" | "recipient_configuration_invalid" | "recipient_origin_forbidden" | "return_destination_not_found" | "recipient_capability_invalid" | "recipient_handoff_invalid" | "preferred_binding_conflict" | "preferred_binding_unavailable" | "subscriber_conflict" | "subscriber_group_conflict" | "subscriber_group_archived" | "resource_not_found" | "resource_expired" | "cancellation_too_late" | "credential_organization_mismatch" | "endpoint_rotation_conflict" | "rate_limited" | "provider_retryable" | "provider_terminal" | "provider_outcome_unknown" | "internal_error" | "not_consented_for_marketing";
 /**
  * Creates one logical message for one subscriber and one resolved channel binding.
  */
@@ -499,6 +551,10 @@ export type CreateMessageRequest = {
      * A required-type tagged union. C0 supports confirm, single-select, and input only.
      */
     interaction?: ConfirmInteractionRequest | SelectInteractionRequest | InputInteractionRequest;
+    /**
+     * Omitted means service. Marketing refuses service-only bindings before charging and at every delayed dispatch.
+     */
+    purpose?: "service" | "marketing";
 };
 export type MessageContent = TextContent | DocumentContent;
 /**
@@ -583,6 +639,10 @@ export type Message = {
      */
     connection_test_id?: string;
     outcome_guidance?: "Delivery may have been accepted by the provider. No automatic retry is scheduled; create a new message explicitly if another attempt is appropriate.";
+    /**
+     * Omitted means service. Marketing refuses service-only bindings before charging and at every delayed dispatch.
+     */
+    purpose?: "service" | "marketing";
 };
 /**
  * The effective provider boundary selected for a message. Connection delivery uses the exact authorized environment connection; simulator delivery never calls a provider.
@@ -1129,6 +1189,13 @@ export type Problem1 = {
     code?: "internal_error";
     retryable?: true;
     [k: string]: unknown;
+} | {
+    type?: "https://whooshbang.flowxo.com/problems/not_consented_for_marketing";
+    title?: "Marketing consent required";
+    status?: 422;
+    code?: "not_consented_for_marketing";
+    retryable?: false;
+    [k: string]: unknown;
 };
 /**
  * Visible ASCII, scoped by authenticated environment, operation ID, and key, and retained for seven days from first acceptance.
@@ -1288,10 +1355,6 @@ export type EmailDomainGuide = {
      */
     instructions_url?: string;
 };
-/**
- * Exactly one mailbox: an unquoted ASCII dot-atom local part plus a canonical lower-case IDNA domain. The comparison key preserves local-part bytes and case and lower-cases only the domain; dot, plus-tag, alias and provider equivalence are never inferred.
- */
-export type EmailAddress = string;
 /**
  * How consent for this exact subscriber, notifier and connection was established. A customer assertion never becomes recipient-observed verification. Complaint, unsubscribe and suppression override either arm.
  */
@@ -2361,6 +2424,40 @@ export type SubscriberGroupMembership = {
     updated_at: Timestamp;
     diagnostic_id: DiagnosticId;
 };
+/**
+ * Assert prior consent or enroll an application-verified user for service email on an exact customer-owned connection. Revocation and sending restrictions always win.
+ */
+export type AssertEmailConsentRequest = {
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    connection_id: OpaqueIdentifier;
+    domain_id: OpaqueIdentifier;
+    address: EmailAddress;
+    consented: true;
+    /**
+     * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
+     */
+    consented_at: string;
+    /**
+     * A bounded customer description of where consent was collected. The authenticated asserting actor is recorded by the service, never accepted from this object.
+     */
+    source?: string;
+} | {
+    subscriber_id: OpaqueIdentifier;
+    notifier_id: OpaqueIdentifier;
+    connection_id: OpaqueIdentifier;
+    domain_id: OpaqueIdentifier;
+    address: EmailAddress;
+    /**
+     * A bounded customer description of the service relationship. The authenticated asserting actor is recorded by the service, never accepted from this object.
+     */
+    source: string;
+    basis: "service";
+    /**
+     * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
+     */
+    relationship_started_at: string;
+};
 /**
  * A calendar day in UTC, as `YYYY-MM-DD`.
  */
@@ -2415,24 +2512,6 @@ export type MachineScopeSummary = [
     ("machine-messages:write" | "machine-messages:read" | "machine-events:read" | "machine-events:ack"),
     ("machine-messages:write" | "machine-messages:read" | "machine-events:read" | "machine-events:ack")
 ];
-/**
- * Account subscription selection for initial Checkout or a quoted change. Additional project quantities have a technical Checkout bound. The server selects approved prices and allowances. Attribution is included on Team and Agency; PAYG may purchase the account-wide add-on.
- */
-export type CreateSubscriptionCheckoutRequest = CreateSubscriptionCheckoutRequest1 & {
-    plan: "payg" | "team" | "agency";
-    hide_attribution: boolean;
-    additional_projects: number;
-};
-export type CreateSubscriptionCheckoutRequest1 = {
-    plan?: "team" | "agency";
-    [k: string]: unknown;
-} | {
-    hide_attribution?: true;
-    [k: string]: unknown;
-} | {
-    additional_projects?: number;
-    [k: string]: unknown;
-};
 /**
  * The current Clerk organization projected as a WhooshBang tenant. Clerk organization and user identifiers are not public fields.
  */
@@ -2448,6 +2527,81 @@ export interface OrganizationProjection {
 export interface OrganizationMembershipSummary {
     role: OrganizationRole;
 }
+/**
+ * One person in the organization, or one invitation to it. Identity-provider identifiers are not public fields.
+ */
+export interface Teammate {
+    id: OpaqueIdentifier;
+    status: TeammateStatus;
+    role: OrganizationRole;
+    /**
+     * The person's name, when they have given one. Null for an invitation.
+     */
+    name: null | string;
+    /**
+     * The address the person signs in with, or the address invited.
+     */
+    email: null | string;
+    projects: TeammateProjectAccess;
+    /**
+     * Whether this is the person making the request.
+     */
+    is_current_user: boolean;
+    /**
+     * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
+     */
+    created_at: string;
+    /**
+     * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
+     */
+    expires_at?: string;
+}
+/**
+ * Which projects the teammate can see. An admin sees every project, including ones created later.
+ */
+export interface TeammateProjectAccess {
+    all: boolean;
+    /**
+     * The projects given to this teammate. Empty when `all` is true.
+     *
+     * @maxItems 1000
+     */
+    project_ids: OpaqueIdentifier[];
+}
+/**
+ * Everybody in the organization and every open invitation, people first.
+ */
+export interface TeammateCollection {
+    /**
+     * @maxItems 100
+     */
+    items: Teammate[];
+    next_cursor?: string;
+    page?: ListPageNumber;
+    page_size?: ListPageSize;
+    total: ListTotal;
+}
+/**
+ * A role and, except for an admin, at least one project. An admin sees every project and takes no list.
+ */
+export interface TeammateAccessRequest {
+    role: OrganizationRole;
+    /**
+     * @maxItems 1000
+     */
+    project_ids?: OpaqueIdentifier[];
+}
+/**
+ * Invites one person by email with their role and projects in one step.
+ */
+export interface InviteTeammateRequest {
+    email: EmailAddress;
+    role: OrganizationRole;
+    /**
+     * @maxItems 1000
+     */
+    project_ids?: OpaqueIdentifier[];
+}
 /**
  * Exact, explicit confirmation that the current organization administrator intends to close the whole organization.
  */
@@ -6662,6 +6816,10 @@ export interface CreateGroupBroadcastRequest {
      * A required-type tagged union. C0 supports confirm, single-select, and input only.
      */
     interaction?: ConfirmInteractionRequest | SelectInteractionRequest | InputInteractionRequest;
+    /**
+     * Omitted means service. Marketing refuses service-only bindings before charging and at every delayed dispatch.
+     */
+    purpose?: "service" | "marketing";
 }
 /**
  * One durable acceptance against an exact group membership revision. Delivery remains represented by ordinary child messages.
@@ -6698,25 +6856,6 @@ export interface BroadcastAggregate {
     cancelled: number;
     expired: number;
 }
-/**
- * Atomically create or resolve one subscriber and assert existing consent for an exact customer-owned email connection and domain. No verification message is sent. Revocation, suppression, recipient pause, holds and unhealthy authority take precedence. An omitted source is recorded as customer.
- */
-export interface AssertEmailConsentRequest {
-    subscriber_id: OpaqueIdentifier;
-    notifier_id: OpaqueIdentifier;
-    connection_id: OpaqueIdentifier;
-    domain_id: OpaqueIdentifier;
-    address: EmailAddress;
-    consented: true;
-    /**
-     * An RFC 3339 timestamp with a UTC offset. The server is authoritative.
-     */
-    consented_at: string;
-    /**
-     * A bounded customer description of where consent was collected. The authenticated asserting actor is recorded by the service, never accepted from this object.
-     */
-    source?: string;
-}
 /**
  * An environment's accepted messages per UTC day over an inclusive range, one bucket for every day in the range including days with none, oldest first. `totals` sums the range.
  */
@@ -7797,7 +7936,7 @@ export interface MessageNotificationImage {
     data_base64: string;
 }
 /**
- * Shared account wallet. Bonus funds core sends only; shared email draws purchased or starter credit. Amounts are exact USD decimal strings. Negative purchased or bonus balances retain refund debt and are not spendable.
+ * Shared account message credit. Bonus funds core sends only; shared email draws purchased or starter credit. Amounts are exact USD decimal strings. Negative purchased or bonus balances retain refund debt and are not spendable.
  */
 export interface BillingAccount {
     currency: "USD";
@@ -7808,23 +7947,128 @@ export interface BillingAccount {
     available_email_credit_usd: string;
     core_price_per_1000_usd: "3.000000";
     shared_email_price_per_1000_usd: "1.000000";
-    checkout_available: boolean;
+    /**
+     * Whether this deployment can take card payments now. When false, credit, plans and add-ons cannot be bought.
+     */
+    purchases_available: boolean;
     packs: {
         purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
         core_credit_usd: string;
     }[];
+    card: null | BillingCard;
+    /**
+     * Where receipts and invoices are emailed. Null sends none.
+     */
+    receipt_email: null | EmailAddress;
 }
-export interface CreateWalletCheckoutRequest {
-    purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
+/**
+ * The organization's one default card. It pays for credit, automatic top-up, plans and add-ons. Only the brand, last four digits and expiry are ever returned.
+ */
+export interface BillingCard {
+    brand: string;
+    last_four: string;
+    exp_month: number;
+    exp_year: number;
 }
-export interface WalletCheckout {
+/**
+ * A card form session. A person enters the card in the embeddable payment form mounted with client_secret and publishable_key, then reconciles. A complete setup makes that card the one default card. client_secret is present only while open.
+ */
+export interface CardSetup {
     id: string;
     status: "open" | "complete" | "expired";
-    checkout_url: string | null;
+    client_secret: string | null;
+    publishable_key: string | null;
+    card: null | BillingCard;
 }
-export interface ReconcileWalletCheckoutResult {
-    outcome: "applied" | "unpaid" | "ignored";
-    account: BillingAccount;
+/**
+ * Buy one credit pack now with the default card. The amount is the explicit approval of the charge.
+ */
+export interface CreateCreditPurchaseRequest {
+    purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
+}
+/**
+ * A credit pack charged to the default card. paid means the credit is in the balance. requires_action means the card issuer asks the customer to confirm in the payment form using client_secret; reconcile afterwards. A failed purchase charged nothing; start a new one after updating the card.
+ */
+export interface CreditPurchase {
+    id: string;
+    purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
+    credit_usd: string;
+    status: "processing" | "requires_action" | "paid" | "failed";
+    failure: ("card_declined" | "authentication_failed") | null;
+    client_secret: string | null;
+    /**
+     * The public key the payment form uses with client_secret. Present only with client_secret.
+     */
+    publishable_key: string | null;
+    card: BillingCard;
+}
+/**
+ * One charge or credit grant. Credit purchases carry purchase_cents; recurring invoices carry their items and paid period. document_url downloads the invoice PDF or opens the receipt.
+ */
+export interface BillingInvoice {
+    id: string;
+    kind: "credit" | "automatic_top_up" | "recurring" | "welcome_credit";
+    created_at: string;
+    amount_usd: string;
+    status: "paid" | "open" | "void" | "uncollectible" | "refunded" | "free";
+    purchase_cents: (500 | 1000 | 2500 | 5000 | 10000) | null;
+    /**
+     * @maxItems 3
+     */
+    items: [] | [
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        }
+    ] | [
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        },
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        }
+    ] | [
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        },
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        },
+        {
+            kind: "team" | "agency" | "attribution" | "project";
+            quantity: number;
+        }
+    ];
+    period_start: string | null;
+    period_end: string | null;
+    document_url: string | null;
+    document_kind: ("invoice" | "receipt") | null;
+}
+/**
+ * A page of invoices and receipts, newest first.
+ */
+export interface BillingInvoiceCollection {
+    /**
+     * @maxItems 100
+     */
+    items: BillingInvoice[];
+    next_cursor?: string;
+    page?: ListPageNumber;
+    page_size?: ListPageSize;
+    total?: ListTotal;
+}
+/**
+ * Where receipts and invoices are emailed. Null stops them.
+ */
+export interface UpdateBillingReceiptEmailRequest {
+    /**
+     * The receipt address, or null.
+     */
+    email: null | EmailAddress;
 }
 export interface BillingEntitlements {
     /**
@@ -7838,7 +8082,10 @@ export interface BillingEntitlements {
     live_notifications_remaining: string;
     shared_emails_remaining: string;
     allowance_period_end: string | null;
-    recurring_checkout_available: boolean;
+    /**
+     * Whether plans and add-ons can be bought now. False when the deployment has no recurring catalog or cannot take payments.
+     */
+    recurring_available: boolean;
     offers: {
         kind: "team" | "agency" | "attribution" | "project";
         monthly_price_usd: string;
@@ -7847,19 +8094,44 @@ export interface BillingEntitlements {
         included_projects: number;
         hide_attribution: boolean;
     }[];
-    pending_subscription_checkout_id: string | null;
-    subscription_management_available: boolean;
     has_subscription: boolean;
     pending_subscription_change_id?: string | null;
+    /**
+     * A recurring charge the default card did not pay. Paid access continues until the paid boundary; another attempt follows at next_attempt_at, or none when null. Update the card to settle it.
+     */
+    payment_issue: null | {
+        amount_usd: string;
+        next_attempt_at: string | null;
+    };
+    recurring_selection?: SubscriptionSelection;
 }
-export interface SubscriptionCheckout {
-    id: string;
-    status: "open" | "complete" | "expired";
-    checkout_url: string | null;
+/**
+ * Selection that will renew; paid project capacity can also include dropped extras until their original expiry. Optional for compatibility with older servers.
+ */
+export interface SubscriptionSelection {
+    plan: "payg" | "team" | "agency";
+    /**
+     * Remove WhooshBang branding from recipient emails, messages and subscription pages.
+     */
+    hide_attribution: boolean;
+    /**
+     * Extra projects beyond the plan's included projects, each billed monthly.
+     */
+    additional_projects: number;
 }
-export interface ReconcileSubscriptionCheckoutResult {
-    outcome: "applied" | "unpaid" | "ignored";
-    entitlements: BillingEntitlements;
+/**
+ * An account's recurring selection: a plan, branding removal and extra projects. The server selects approved prices and allowances. Branding removal is included on Team and Agency; Pay as you go may add it. Choosing Pay as you go with nothing else ends every recurring charge at the paid boundary.
+ */
+export interface SubscriptionSelection1 {
+    plan: "payg" | "team" | "agency";
+    /**
+     * Remove WhooshBang branding from recipient emails, messages and subscription pages.
+     */
+    hide_attribution: boolean;
+    /**
+     * Extra projects beyond the plan's included projects, each billed monthly.
+     */
+    additional_projects: number;
 }
 /**
  * The saved project preference and current server-enforced paid entitlement. Expiry restores visible attribution without changing sender identity, consent, unsubscribe or answer controls.
@@ -7872,20 +8144,17 @@ export interface ProjectAttribution {
 export interface UpdateProjectAttributionRequest {
     hide_attribution: boolean;
 }
-export interface BillingPortalSession {
-    portal_url: string;
-}
 /**
- * Reusable account project slots. After a downgrade the oldest requested projects retain active slots. Unassigned projects retain data, accepted delivery and answers; new live sends require an active slot.
+ * Reusable account project slots. After a downgrade the oldest requested projects retain active slots. Unassigned projects retain data, accepted delivery and answers; new live sends require an active slot. Paid capacity includes all unexpired project purchases, so retained dropped extras can exceed the maximum renewing selection.
  */
 export interface BillingProjectSlots {
     project_capacity: number;
     /**
-     * @maxItems 10025
+     * @maxItems 2147483647
      */
     requested_project_ids: OpaqueIdentifier[];
     /**
-     * @maxItems 10025
+     * @maxItems 2147483647
      */
     active_project_ids: OpaqueIdentifier[];
 }
@@ -7904,6 +8173,9 @@ export interface UpdateAutoTopUpSettingsRequest {
     trigger_cents: number;
     monthly_cap_cents: number;
 }
+/**
+ * Automatic top-up is off by default. When on, the default card buys the selected pack whenever credit falls below the trigger. The monthly cap counts pending and paid purchases started in each UTC calendar month; refunds do not restore it. Turning it off stops future purchases; one already processing may finish. needs_card means there is no default card yet.
+ */
 export interface AutoTopUpSettings {
     enabled: boolean;
     purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
@@ -7912,35 +8184,45 @@ export interface AutoTopUpSettings {
     available: boolean;
     monthly_reserved_cents: number;
     state: "disabled" | "needs_card" | "ready" | "processing" | "card_update_required" | "monthly_cap_reached";
-    saved_card: null | {
-        brand: string;
-        last_four: string;
+    card: null | BillingCard;
+    /**
+     * The most recent paid automatic purchase, if any.
+     */
+    last_purchase: null | {
+        id: string;
+        purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
+        credit_usd: string;
+        completed_at: string;
     };
-    pending_setup_id: string | null;
-}
-export interface AutoTopUpSetup {
-    id: string;
-    status: "open" | "complete" | "expired";
-    checkout_url: string | null;
-}
-export interface ReconcileAutoTopUpSetupResult {
-    outcome: "applied" | "unpaid" | "ignored";
-    settings: AutoTopUpSettings;
 }
 /**
- * An owned immutable recurring selection. A reserved quote has not charged a card. Confirm its exact immediate cash charge; paid upgrades reset the cycle and carry unused paid time, while reductions start at the existing paid boundary. Processing or pending outcomes must be recovered without starting another change.
+ * An owned recurring selection. A reserved quote has not charged anything. start buys the first plan or add-on; upgrade charges now, resets the cycle and credits unused paid time; boundary reductions start at the existing paid boundary. Confirm the exact immediate charge; the default card pays it. Processing or pending changes are recovered, never repeated.
  */
 export interface SubscriptionChange {
     id: string;
-    kind: "upgrade" | "boundary";
+    kind: "start" | "upgrade" | "boundary";
     status: "reserved" | "processing" | "pending" | "scheduled" | "applied" | "expired";
-    selection: CreateSubscriptionCheckoutRequest;
+    selection: SubscriptionSelection1;
     monthly_price_usd: string;
     charge_now_usd: string | null;
+    /**
+     * Compatibility field: new upgrades return 0.000000; starts and boundary changes return null. Historical quotes can retain their recorded unused-time credit. No new automatic unused-time refunds or offsets.
+     */
     unused_time_credit_usd: string | null;
     effective_at: string | null;
     expires_at: string;
-    payment_url: string | null;
+    /**
+     * Present only while the card issuer asks the customer to confirm this charge in the payment form.
+     */
+    client_secret: string | null;
+    /**
+     * The public key the payment form uses with client_secret. Present only with client_secret.
+     */
+    publishable_key: string | null;
+    /**
+     * Why the last charge attempt failed. Update the card, then confirm again.
+     */
+    failure: ("card_declined" | "authentication_failed") | null;
 }
 export interface ConfirmSubscriptionChangeRequest {
     /**