subscription

Author: mostafa6765

doc/subscription.md

@@ -1,117 +1,62 @@
-# Subscription
+## Usage
 
-lara-stripe has `LaraStripeSubs` alias for subscription related task.
+Here are some common operations you can perform using the `StripeSubscription` library:
 
-# Methods
-
-## `setup()` `required`
-
-setup method as usual setup secret key
-
-* `secret_key`  `required`
-
-```php
-setup([
-    'secret_key' => '********'
-])
-```
-
-## `customer()` `required`
-
-which customer subscribe.
-
-* [create customer first](https://github.com/code4mk/lara-stripe/blob/master/doc/customer.md)
-
-```php
-customer('customer_id')
-```
-
-## `plan()` `required`
-
-Customer subscription which plan.
-
-* [create a plan first](https://github.com/code4mk/lara-stripe/blob/master/doc/customer.md)
-
-```php
-plan('plan_id')
-```
-
-## `trialPlan()` `optional`
-
-If want to set trial period from plan.
+### Creating a Subscription
 
 ```php
-trialPlan()
-```
+use Code4mk\LaraStripe\Lib\StripeSubscription;
 
-## `trail()` `optional`
+$stripeSubscription = new StripeSubscription();
 
-Set tril period for the subscription. This override the plan trail.
+$customerId = 'customer_id_here';
+$priceId = 'price_id_here';
 
-```php
-trial(5)
+$stripeSubscription->customer($customerId) // Set the customer ID
+    ->priceId($priceId) // Set the price (plan) ID
+    ->metaData(['key' => 'value']) // Set additional metadata (optional)
+    ->trialPlan() // Use the default trial from the plan (optional)
+    ->trial(7) // Set a custom trial period in days (optional)
+    ->source('card_source_id') // Set the card source (optional)
+    ->coupon('coupon_code_here') // Apply a coupon (optional)
+    ->create(); // Create the subscription
 ```
 
-## `source()` `optional`
-
-set source (card token generate from stipe.js).
+### Retrieving a Subscription
 
 ```php
-source('tok_***')
-```
+use Code4mk\LaraStripe\Lib\StripeSubscription;
 
-## `coupon()` `optioanl`
+$stripeSubscription = new StripeSubscription();
 
-Subscription with a coupon
+$subscriptionId = 'subscription_id_here';
 
-```php
-coupon('coupon_code')
+$stripeSubscription->retrieve($subscriptionId); // Retrieve the subscription by ID
 ```
 
-## extra `optional`
-
-Add optional attributes which are not include this package for creating subscription.
-
-* [all attributes lists](https://stripe.com/docs/api/subscriptions/create)
+### Canceling a Subscription
 
 ```php
-extra([
-     .....
-])
-```
+use Code4mk\LaraStripe\Lib\StripeSubscription;
 
-## `get()` `required`
+$stripeSubscription = new StripeSubscription();
 
-* create the subscription and retrive created subscription data.
-* return `object`
+$subscriptionId = 'subscription_id_here';
 
-```php
-get()
+$stripeSubscription->cancel($subscriptionId); // Cancel the subscription by ID
 ```
 
-# `Create a Subscription -> Full code`
-
+For more details on available methods and parameters, refer to the inline code comments and the [Stripe API documentation](https://stripe.com/docs/api/subscriptions).
 
-```php
-LaraStripeSubs::setup(['secret_key'=>'******'])
-            ->customer('customer_id')
-            ->plan('plan_id')
-            ->source('tok_***')
-            ->trialPlan()
-            ->coupon('coupon_id')
-            ->get();
-```
+## Error Handling
 
-# `Retrieve the subscription`
+The library provides basic error handling. If an error occurs during an operation, it returns an object with an `isError` property set to `true`, along with an error message.
 
 ```php
-LaraStripeSubs::setup(['secret_key'=>'******'])
-            ->retrieve('subs_id')        
-```
-
-# `Cancel the subscription`
+$result = $stripeSubscription->create();
 
-```php
-LaraStripeSubs::setup(['secret_key'=>'******'])
-            ->cancel('subs_id')        
-```
+if ($result->isError === true) {
+    // Handle the error
+    echo "Error: " . $result->message;
+}
+```