{"info":{"_postman_id":"53e72655-c0e6-426d-9a60-e6ca06fb70d2","name":"laravel stripe manager","description":"

Base URL: {APP_URL}/api/stripe-manager
Default Middleware: ['api']
Authentication: Configure middleware in config/stripe-manager.php under api_routes.middleware

Error Response

{\n  \"error\": \"Error message\",\n  \"message\": \"Detailed error description\"\n}\n\n

Validation Error Response

{\n  \"message\": \"The given data was invalid.\",\n  \"errors\": {\n    \"field_name\": [\n      \"The field name field is required.\"\n    ]\n  }\n}\n\n

Configuration Notes

Authentication Setup

To secure these endpoints, update config/stripe-manager.php:

'api_routes' => [\n    'prefix' => 'api/stripe-manager',\n    'middleware' => ['api', 'auth:sanctum'], // Add your preferred auth middleware\n],\n\n

Amount Format

All amounts are in the smallest currency unit (e.g., cents for USD)
\n
unit_amount: 1999 = $19.99
\n

Trial Behavior

Trials are enforced locally and verified with Stripe when possible
\n
Prevents re-trial abuse by checking previous subscriptions
\n

Database Tables

The API interacts with these local database tables:

em_stripe_products - Product information
\n
em_stripe_product_pricing - Pricing tiers
\n
em_stripe_subscriptions - Subscription data
\n
em_subscription_payments - Payment history
\n
em_stripe_cards - Customer payment methods
\n

Postman Collection Setup

Base URL Variable: Set {{base_url}} to your application URL
\n
Authentication: Configure your preferred auth method (Bearer token, API key, etc.)
\n
Headers: Set Content-Type: application/json for POST/DELETE requests
\n
Environment Variables:
\n
- base_url: http://yourdomain.com (or https://yourdomain.com)
  \n
- api_prefix: api/stripe-manager
  \n
\n

Example Request URLs:

{{base_url}}/{{api_prefix}}/plans
\n
{{base_url}}/{{api_prefix}}/subscription
\n
{{base_url}}/{{api_prefix}}/select-subscription-plan
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21481838","collectionId":"53e72655-c0e6-426d-9a60-e6ca06fb70d2","publishedId":"2sB3QJNAb4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-06T20:03:54.000Z"},"item":[{"name":"Get Plans","id":"0aee0bf2-9ee5-4a46-9b17-a7b9880c861f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base-url}}/{{perfix}}/plans","description":"

Endpoint: GET /api/stripe-manager/plans

Description: Returns all active products with their active pricing from local database (not Stripe).

Authentication: Depends on middleware configuration

Request Parameters: None

Response:

{\n  \"data\": [\n    {\n      \"id\": 1,\n      \"name\": \"Pro Plan\",\n      \"description\": \"Professional features for advanced users\",\n      \"stripe_product_id\": \"prod_1234567890\",\n      \"pricing\": [\n        {\n          \"id\": 10,\n          \"stripe_price_id\": \"price_1234567890\",\n          \"nickname\": \"Monthly\",\n          \"unit_amount\": 1999,\n          \"currency\": \"usd\",\n          \"type\": \"recurring\",\n          \"billing_period\": \"month\",\n          \"billing_period_count\": 1,\n          \"trial_period_days\": 14\n        },\n        {\n          \"id\": 11,\n          \"stripe_price_id\": \"price_0987654321\",\n          \"nickname\": \"Yearly\",\n          \"unit_amount\": 19999,\n          \"currency\": \"usd\",\n          \"type\": \"recurring\",\n          \"billing_period\": \"year\",\n          \"billing_period_count\": 1,\n          \"trial_period_days\": 14\n        }\n      ]\n    }\n  ]\n}\n\n

Status Codes:

200 - Success
\n
401 - Unauthorized (if auth middleware is configured)
\n

\n","urlObject":{"path":["{{perfix}}","plans"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0aee0bf2-9ee5-4a46-9b17-a7b9880c861f"},{"name":"Get User subscription","id":"cb1f1f5f-1468-4172-a37b-e9e6c0b6f174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base-url}}/{{perfix}}/subscription?stripe_id","description":"

Endpoint: GET /api/stripe-manager/subscription

Description: Returns the latest subscription summary for the authenticated user from local database.

Authentication: Required (uses $request->user())

Request Parameters: None

Response:

{\n  \"data\": {\n    \"subscription_id\": 5,\n    \"stripe_subscription_id\": \"sub_1234567890\",\n    \"status\": \"active\",\n    \"product\": \"Pro Plan\",\n    \"price\": {\n      \"nickname\": \"Monthly\",\n      \"unit_amount\": 1999,\n      \"currency\": \"usd\",\n      \"billing_period\": \"month\",\n      \"billing_period_count\": 1\n    },\n    \"current_period_start\": \"2025-01-01 12:00:00\",\n    \"current_period_end\": \"2025-02-01 12:00:00\",\n    \"next_billing_at\": \"2025-02-01 12:00:00\",\n    \"next_billing_amount\": 1999\n  }\n}\n\n

Response (No Subscription):

{\n  \"data\": null\n}\n\n

Status Codes:

200 - Success
\n
401 - Unauthorized
\n

EndFragment

\n","urlObject":{"path":["{{perfix}}","subscription"],"host":["{{base-url}}"],"query":[{"key":"stripe_id","value":null}],"variable":[]}},"response":[],"_postman_id":"cb1f1f5f-1468-4172-a37b-e9e6c0b6f174"},{"name":"Get User subscription trial Info","id":"a5508f5f-97c6-4c07-a061-dab891cdd5f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base-url}}/{{perfix}}/trial-info","description":"

Endpoint: GET /api/stripe-manager/trial-info

Description: Returns the latest trial information for a specific user.

Authentication: Depends on middleware configuration

Query Parameters:

user_id (required): Integer - User ID to get trial info for

Request Example:

GET /api/stripe-manager/trial-info?user_id=123\n\n

Response (Has Trial):

{\n  \"data\": {\n    \"has_trial\": true,\n    \"trial_start\": \"2025-01-01 12:00:00\",\n    \"trial_end\": \"2025-01-15 12:00:00\",\n    \"active\": true\n  }\n}\n\n

Response (No Trial):

{\n  \"data\": {\n    \"has_trial\": false\n  }\n}\n\n

Status Codes:

200 - Success
\n
400 - Validation error (missing user_id)
\n
401 - Unauthorized (if auth middleware is configured)
\n

\n","urlObject":{"path":["{{perfix}}","trial-info"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5508f5f-97c6-4c07-a061-dab891cdd5f2"},{"name":"Get User payment methods","id":"7ee8420b-fb87-4af3-858c-f61f3b74532d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base-url}}/{{perfix}}/user-payment-methods","description":"

Endpoint: GET /api/stripe-manager/user-payment-methods

Description: Lists all card payment methods from Stripe for the authenticated user.

Authentication: Required (uses $request->user())

Request Parameters: None

Response:

{\n  \"data\": [\n    {\n      \"id\": \"pm_1234567890\",\n      \"brand\": \"visa\",\n      \"last4\": \"4242\",\n      \"exp_month\": 12,\n      \"exp_year\": 2025\n    },\n    {\n      \"id\": \"pm_0987654321\",\n      \"brand\": \"mastercard\",\n      \"last4\": \"5555\",\n      \"exp_month\": 6,\n      \"exp_year\": 2026\n    }\n  ]\n}\n\n

Status Codes:

200 - Success
\n
401 - Unauthorized
\n

\n","urlObject":{"path":["{{perfix}}","user-payment-methods"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7ee8420b-fb87-4af3-858c-f61f3b74532d"},{"name":"select subscription plan","id":"578702f2-cddd-4ce3-b327-6eddbc3697bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"plan_id","value":"","type":"text"},{"key":"payment_method_id","value":"","type":"text"}]},"url":"{{base-url}}/{{perfix}}/select-subscription-plan","description":"

Endpoint: POST /api/stripe-manager/select-subscription-plan

Description: Creates a subscription for the authenticated user with the specified payment method.

Authentication: Required (uses $request->user())

Request Body:

{\n  \"plan_id\": 10,\n  \"payment_method_id\": \"pm_1234567890\"\n}\n\n

Validation Rules:

plan_id: Required, integer, must exist in em_stripe_product_pricing table
\n
payment_method_id: Required, string
\n

Response:

{\n  \"data\": {\n    \"id\": 5\n  }\n}\n\n

Behavior Notes:

No repeat trial: If the user previously subscribed to the same pricing, the trial is skipped and the user is charged immediately
\n
Creates subscription both on Stripe and in local database
\n

Status Codes:

201 - Subscription created successfully
\n
400 - Validation error
\n
401 - Unauthorized
\n
404 - Pricing plan not found
\n

\n","urlObject":{"path":["{{perfix}}","select-subscription-plan"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"578702f2-cddd-4ce3-b327-6eddbc3697bf"},{"name":"cancel subscription plan","id":"8409f80e-2079-4594-bb37-c6ec67ebb17f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base-url}}/{{perfix}}/cancel-subscription-plan","description":"

Endpoint: DELETE /api/stripe-manager/cancel-subscription-plan

Description: Cancels the current subscription for the authenticated user.

Authentication: Required (uses $request->user())

Request Body:

{\n  \"immediately\": false\n}\n\n

Validation Rules:

immediately: Optional, boolean (default: false)

Response:

{\n  \"ok\": true\n}\n\n

Behavior Notes:

immediately: true - Cancels immediately and charges for unused time
\n
immediately: false - Cancels at the end of the current billing period
\n
Cancels subscription both on Stripe and updates local database
\n

Status Codes:

200 - Success
\n
400 - Validation error
\n
401 - Unauthorized
\n

\n","urlObject":{"path":["{{perfix}}","cancel-subscription-plan"],"host":["{{base-url}}"],"query":[{"disabled":true,"key":"immediately","value":null}],"variable":[]}},"response":[],"_postman_id":"8409f80e-2079-4594-bb37-c6ec67ebb17f"},{"name":"save stripe id","id":"a051cdaf-598b-4dca-b730-173c9d5beee7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"stripe_id","value":"","type":"text"}]},"url":"{{base-url}}/{{perfix}}/save-stripe-id","description":"

Endpoint: POST /api/stripe-manager/save-stripe-id

Description: Saves a known Stripe customer ID to the authenticated user's record.

Authentication: Required (uses $request->user())

Request Body:

{\n  \"stripe_id\": \"cus_1234567890\"\n}\n\n

Validation Rules:

stripe_id: Required, string

Response:

{\n  \"ok\": true\n}\n\n

Status Codes:

200 - Success
\n
400 - Validation error
\n
401 - Unauthorized
\n

\n","urlObject":{"path":["{{perfix}}","save-stripe-id"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a051cdaf-598b-4dca-b730-173c9d5beee7"},{"name":"set default payment method","id":"8eb886d6-4e88-48db-8f61-c0a4d4097aa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"payment_method_id","value":"","type":"text"}]},"url":"{{base-url}}/{{perfix}}/set-default-payment-method","description":"

Endpoint: POST /api/stripe-manager/set-default-payment-method

Description: Sets the user's default payment method on Stripe.

Authentication: Required (uses $request->user())

Request Body:

{\n  \"payment_method_id\": \"pm_1234567890\"\n}\n\n

Validation Rules:

payment_method_id: Required, string

Response:

{\n  \"ok\": true\n}\n\n

Status Codes:

200 - Success
\n
400 - Validation error
\n
401 - Unauthorized
\n

\n","urlObject":{"path":["{{perfix}}","set-default-payment-method"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8eb886d6-4e88-48db-8f61-c0a4d4097aa3"}]}