> ## Documentation Index > Fetch the complete documentation index at: https://docs.tagada.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the published customer portal of the store with its retention, Membership and products > Get the published customer portal of the store with its retention, Membership and products ## OpenAPI ````yaml /openapi.json get /api/v1/portal/config openapi: 3.0.3 info: title: TagadaPay API description: >- # TagadaPay API Documentation Welcome to the TagadaPay API. This REST API lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically. ## Authentication Authenticate every request with a Bearer token. Get your API key from the [TagadaPay Dashboard](https://app.tagada.io). ``` Authorization: Bearer your-api-key ``` All requests must be made over HTTPS with `Content-Type: application/json`. ## Rate Limits | Plan | Requests/min | Burst | |------|-------------|-------| | Standard | 100 | 150 | | Premium | 500 | 750 | Exceeding the limit returns `429 Too Many Requests`. ## Errors | Code | Meaning | |------|---------| | 400 | Bad request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient permissions | | 404 | Not found | | 409 | Conflict | | 429 | Rate limited | | 500 | Server error | ## Support - Email: api-support@tagada.io - Docs: [docs.tagadapay.com](https://docs.tagadapay.com) version: 1.0.0 servers: - url: https://api.tagada.io/ description: Production - url: https://api.tagada.dev/ description: Sandbox / Development security: - bearerAuth: [] tags: - name: auth description: Test your API key and verify authentication. - name: stores description: Create and manage stores within your account. - name: products description: Create products with variants, prices, and currency options. - name: customers description: Manage customer records, addresses, and payment instruments. - name: orders description: List and retrieve orders with line items, payments, and metadata. - name: payments description: Process, list, refund, void, and dispute payments. - name: subscriptions description: >- Create and manage recurring subscriptions — billing, cancellation, rebilling, and processor changes. - name: payment-flows description: Configure payment routing strategies with cascading processor fallbacks. - name: payment-instruments description: >- Manage stored payment methods — cards, bank accounts, and tokenized instruments. - name: processors description: List connected payment processors (Stripe, NMI, Checkout.com, etc.). - name: promotions description: Create and manage discount promotions with rules and conditions. - name: promotion-codes description: Generate and manage reusable promotion/coupon codes. - name: block-rules description: >- Configure fraud prevention rules to block transactions by IP, email, card BIN, country, etc. - name: webhooks description: Register webhook endpoints to receive real-time event notifications. - name: events description: Query application events, statistics, and audit logs. - name: domains description: Add, verify, and manage custom domains for your checkout and funnels. - name: funnels description: >- Create and manage checkout funnels with routing, A/B testing, and CDN deployment. - name: funnel-sessions description: Retrieve funnel session data for analytics and debugging. - name: funnel-tracking description: Track funnel step events for conversion analytics. - name: plugins description: Deploy, manage, and configure checkout plugins. - name: plugins-v2 description: >- V2 plugin system — deploy, mount, split-test, fork, promote, and manage plugin instances. - name: checkout description: >- Initialize checkout sessions and process payments through the hosted checkout. - name: 3ds description: >- 3D Secure authentication — create sessions, authenticate, and handle challenges. - name: builder description: Generate and validate builder session tokens for the visual page editor. - name: health description: API health check endpoint. - name: test description: Test and debugging utilities for the event system (sandbox only). paths: /api/v1/portal/config: get: tags: - portal summary: >- Get the published customer portal of the store with its retention, Membership and products description: >- Get the published customer portal of the store with its retention, Membership and products operationId: get-api-v1-portal-config parameters: - name: storeId in: query required: true schema: type: string minLength: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: store: type: object properties: id: type: string name: type: string domain: type: string currency: type: string pattern: ^[A-Z]{3}$ currencies: type: array items: type: string pattern: ^[A-Z]{3}$ checkoutDomain: type: string supportEmail: type: string logo: type: string shippingFlatRate: type: integer storefronts: type: object properties: shopify: type: boolean woocommerce: type: boolean required: - shopify - woocommerce additionalProperties: false required: - id - name - domain - currency - currencies - checkoutDomain - supportEmail - logo - shippingFlatRate - storefronts additionalProperties: false portal: type: object properties: schemaVersion: type: number enum: - 1 templateId: type: string enum: - essential - editorial - bold theme: type: object properties: logo: type: string nullable: true accent: type: string accentContrast: type: string background: type: string surface: type: string text: type: string mutedText: type: string border: type: string radius: type: number minimum: 0 headingFont: type: string bodyFont: type: string buttonShape: type: string enum: - rounded - pill - square required: - logo - accent - accentContrast - background - surface - text - mutedText - border - radius - headingFont - bodyFont - buttonShape additionalProperties: false layout: type: string enum: - sidebar - top-tabs - top-nav-rail pages: type: object properties: home: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false subscriptions: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false subscription: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false orders: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false order: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false membership: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false credits: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false account: type: array items: type: object properties: id: type: string minLength: 1 visible: type: boolean area: type: string enum: - header - main - side width: type: string enum: - full - half layout: type: string enum: - list - grid heading: type: string nullable: true actions: type: object properties: send-now: type: boolean skip: type: boolean pause: type: boolean change-date: type: boolean change-frequency: type: boolean swap: type: boolean change-quantity: type: boolean cancel: type: boolean additionalProperties: false required: - id - visible - area - width - layout - heading - actions additionalProperties: false required: - home - subscriptions - subscription - orders - order - membership - credits - account additionalProperties: false copy: type: object properties: welcomeTitle: type: string welcomeBody: type: string supportLabel: type: string required: - welcomeTitle - welcomeBody - supportLabel additionalProperties: false status: type: string enum: - draft - live permissions: type: object properties: canSkip: type: boolean canPause: type: boolean maxPauseDays: type: integer minimum: 1 canChangeDate: type: boolean canChangeFrequency: type: boolean canSwapProduct: type: boolean canChangeQuantity: type: boolean canCancel: type: boolean required: - canSkip - canPause - maxPauseDays - canChangeDate - canChangeFrequency - canSwapProduct - canChangeQuantity - canCancel additionalProperties: false customDomain: type: string nullable: true required: - schemaVersion - templateId - theme - layout - pages - copy - status - permissions - customDomain additionalProperties: false retention: type: object properties: reasons: type: array items: type: object properties: id: type: string label: type: string offerId: type: string nullable: true appliesTo: type: string enum: - subscription - membership - both required: - id - label - offerId - appliesTo additionalProperties: false offers: type: array items: type: object properties: id: type: string kind: type: string enum: - discount - skip - pause - frequency - swap - downgrade-yearly title: type: string body: type: string value: type: number nullable: true appliesTo: type: string enum: - subscription - membership - both enabled: type: boolean required: - id - kind - title - body - value - appliesTo - enabled additionalProperties: false confirm: type: object properties: subscription: type: object properties: title: type: string body: type: string required: - title - body additionalProperties: false membership: type: object properties: title: type: string body: type: string required: - title - body additionalProperties: false required: - subscription - membership additionalProperties: false required: - reasons - offers - confirm additionalProperties: false membership: type: object properties: id: type: string productId: type: string name: type: string status: type: string enum: - active - draft description: type: string image: type: string options: type: array items: type: object properties: id: type: string enum: - monthly - yearly label: type: string interval: type: string enum: - month - year price: type: object additionalProperties: type: integer enabled: type: boolean isDefault: type: boolean required: - id - label - interval - price - enabled - isDefault additionalProperties: false minimumMonths: type: integer minimum: 1 nullable: true perks: type: object properties: enabled: type: object properties: memberPrices: type: boolean storewideDiscount: type: boolean freeShipping: type: boolean monthlyCredits: type: boolean creditPrices: type: boolean creditPacks: type: boolean memberOnly: type: boolean required: - memberPrices - storewideDiscount - freeShipping - monthlyCredits - creditPrices - creditPacks - memberOnly additionalProperties: false memberPricePercent: type: number minimum: 0 maximum: 100 memberPriceProductIds: type: array items: type: string memberPriceOverrides: type: array items: type: object properties: productId: type: string percent: type: number minimum: 0 maximum: 100 required: - productId - percent additionalProperties: false includeNewProducts: type: boolean monthlyCredits: type: integer minimum: 0 creditRolloverCap: type: integer minimum: 0 nullable: true creditsUsableAfterCancelDays: type: integer minimum: 0 creditPrices: type: array items: type: object properties: productId: type: string credits: type: integer minimum: 1 required: - productId - credits additionalProperties: false freeShippingThreshold: type: integer minimum: 0 nullable: true storewideDiscountPercent: type: number minimum: 0 maximum: 100 perksOnJoiningOrder: type: boolean required: - enabled - memberPricePercent - memberPriceProductIds - memberPriceOverrides - includeNewProducts - monthlyCredits - creditRolloverCap - creditsUsableAfterCancelDays - creditPrices - freeShippingThreshold - storewideDiscountPercent - perksOnJoiningOrder additionalProperties: false creditPacks: type: array items: type: object properties: id: type: string productId: type: string name: type: string credits: type: integer minimum: 1 bonusCredits: type: integer minimum: 0 price: type: integer minimum: 0 membersOnly: type: boolean required: - id - productId - name - credits - bonusCredits - price - membersOnly additionalProperties: false memberOnlyProductIds: type: array items: type: string perkTitles: type: object properties: memberPrices: type: string storewideDiscount: type: string freeShipping: type: string monthlyCredits: type: string creditPrices: type: string creditPacks: type: string memberOnly: type: string required: - memberPrices - storewideDiscount - freeShipping - monthlyCredits - creditPrices - creditPacks - memberOnly additionalProperties: false gracePeriodDays: type: integer minimum: 0 required: - id - productId - name - status - description - image - options - minimumMonths - perks - creditPacks - memberOnlyProductIds - perkTitles - gracePeriodDays additionalProperties: false nullable: true products: type: array items: type: object properties: id: type: string title: type: string handle: type: string description: type: string status: type: string enum: - active - draft image: type: string nullable: true variants: type: array items: type: object properties: id: type: string title: type: string sku: type: string price: type: integer prices: type: object additionalProperties: type: integer compareAtPrice: type: integer nullable: true inventory: type: integer required: - id - title - sku - price - prices - compareAtPrice - inventory additionalProperties: false purchaseMode: type: string enum: - one-time - one-time-and-subscription - subscription-only options: type: array items: type: object properties: id: type: string label: type: string interval: type: string enum: - week - month - year intervalCount: type: integer minimum: 1 discountPercent: type: number minimum: 0 maximum: 100 nullable: true origin: type: string enum: - tagada - shopify_tagada - shopify_external shopifySynced: type: boolean minimumCycles: type: integer minimum: 1 nullable: true isDefault: type: boolean variantPrices: type: object additionalProperties: type: object additionalProperties: type: integer subscribers: type: integer minimum: 0 required: - id - label - interval - intervalCount - discountPercent - origin - shopifySynced - minimumCycles - isDefault - variantPrices additionalProperties: false memberOnly: type: boolean permissionOverrides: type: object properties: canSkip: type: boolean canPause: type: boolean canChangeDate: type: boolean canChangeFrequency: type: boolean canSwapProduct: type: boolean canChangeQuantity: type: boolean canCancel: type: boolean additionalProperties: false required: - id - title - handle - description - status - image - variants - purchaseMode - options - memberOnly - permissionOverrides additionalProperties: false required: - store - portal - retention - membership - products additionalProperties: false default: $ref: '#/components/responses/error' security: [] components: responses: error: description: Error response content: application/json: schema: type: object properties: message: type: string code: type: string issues: type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your API key as: `Bearer your-api-key`' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.