​

Square

​

Configuration

// config/subscribd.php
'gateways' => [
    'square' => [
        'driver'         => \Pixelworxio\Subscribd\Gateways\SquareGateway::class,
        'access_token'   => env('SQUARE_ACCESS_TOKEN'),
        'application_id' => env('SQUARE_APPLICATION_ID'),
        'location_id'    => env('SQUARE_LOCATION_ID'),
        'webhook_secret' => env('SQUARE_WEBHOOK_SIGNATURE_KEY'),
        'webhook_url'    => env('SQUARE_WEBHOOK_URL'),
        'sandbox'        => env('SQUARE_SANDBOX', false),
    ],
],

​

Environment variables

SQUARE_ACCESS_TOKEN=...
SQUARE_APPLICATION_ID=...
SQUARE_LOCATION_ID=...
SQUARE_WEBHOOK_SIGNATURE_KEY=...
SQUARE_WEBHOOK_URL=https://yourapp.com/subscribd/webhook/square
SQUARE_SANDBOX=false

​

Webhooks

• subscription.created
• subscription.updated
• subscription.canceled
• subscription.expired
• invoice.payment_made
• invoice.payment_failed
• payment.completed
• payment.failed

​

Limitations

• interval_count must be 1. Square does not support billing cycles with interval_count > 1. Subscribd throws SubscriptionException if you attempt to create a subscription on a plan with interval_count > 1 using this gateway.
• Trial extension is not supported natively. ExtendTrial updates the local trial_ends_at only.
• Proration is handled by Subscribd’s built-in ProrationEngine.
• Pausing is not supported natively. Subscribd updates the local status only.

​

Next steps

• Custom Gateways — Build your own gateway driver
• Webhooks — Full webhook reference