Overview

Classes

  • Syspay_Merchant_AstroPayBanksRequest
  • Syspay_Merchant_BillingAgreementCancellationRequest
  • Syspay_Merchant_BillingAgreementInfoRequest
  • Syspay_Merchant_BillingAgreementListRequest
  • Syspay_Merchant_BillingAgreementRequest
  • Syspay_Merchant_ChargebackInfoRequest
  • Syspay_Merchant_ChargebackListRequest
  • Syspay_Merchant_Client
  • Syspay_Merchant_ConfirmRequest
  • Syspay_Merchant_EMS
  • Syspay_Merchant_Entity
  • Syspay_Merchant_Entity_AstroPayBank
  • Syspay_Merchant_Entity_BillingAgreement
  • Syspay_Merchant_Entity_Chargeback
  • Syspay_Merchant_Entity_Creditcard
  • Syspay_Merchant_Entity_Customer
  • Syspay_Merchant_Entity_Eterminal
  • Syspay_Merchant_Entity_Payment
  • Syspay_Merchant_Entity_PaymentMethod
  • Syspay_Merchant_Entity_PaymentRecipient
  • Syspay_Merchant_Entity_Plan
  • Syspay_Merchant_Entity_Refund
  • Syspay_Merchant_Entity_Subscription
  • Syspay_Merchant_Entity_SubscriptionEvent
  • Syspay_Merchant_EterminalRequest
  • Syspay_Merchant_IpAddressesRequest
  • Syspay_Merchant_PaymentInfoRequest
  • Syspay_Merchant_PaymentListRequest
  • Syspay_Merchant_PaymentRequest
  • Syspay_Merchant_PlanInfoRequest
  • Syspay_Merchant_PlanRequest
  • Syspay_Merchant_PlanUpdateRequest
  • Syspay_Merchant_RebillRequest
  • Syspay_Merchant_Redirect
  • Syspay_Merchant_RefundInfoRequest
  • Syspay_Merchant_RefundListRequest
  • Syspay_Merchant_RefundRequest
  • Syspay_Merchant_Request
  • Syspay_Merchant_SubscriptionCancellationRequest
  • Syspay_Merchant_SubscriptionInfoRequest
  • Syspay_Merchant_SubscriptionRebillRequest
  • Syspay_Merchant_SubscriptionRequest
  • Syspay_Merchant_Utils
  • Syspay_Merchant_VoidRequest

Interfaces

  • Syspay_Merchant_Entity_ReturnedEntityInterface

Exceptions

  • Syspay_Merchant_EMSException
  • Syspay_Merchant_RedirectException
  • Syspay_Merchant_RequestException
  • Syspay_Merchant_UnexpectedResponseException
  • Overview
  • Class
  • Tree

Class Syspay_Merchant_Entity_Subscription

A subscription object

Syspay_Merchant_Entity
Extended by Syspay_Merchant_Entity_Subscription implements Syspay_Merchant_Entity_ReturnedEntityInterface
Located at Syspay/SDK/Merchant/Entity/Subscription.php
Methods summary
public static Syspay_Merchant_Entity_Subscription
# buildFromResponse( stdClass $response )

Build a subscription entity based on a json-decoded subscription stdClass

Build a subscription entity based on a json-decoded subscription stdClass

Parameters

$response
The subscription data

Returns

Syspay_Merchant_Entity_Subscription
The subscription object

Implementation of

Syspay_Merchant_Entity_ReturnedEntityInterface::buildFromResponse()
public integer
# getId( )

Gets the value of id.

Gets the value of id.

Returns

integer
integer
public Syspay_Merchant_Entity_Subscription
# setId( integer $id )

Sets the value of id.

Sets the value of id.

Parameters

$id
the id

Returns

Syspay_Merchant_Entity_Subscription
self
public DateTime
# getCreated( )

Gets the value of created.

Gets the value of created.

Returns

DateTime
DateTime
public Syspay_Merchant_Entity_Subscription
# setCreated( DateTime $created = null )

Sets the value of created.

Sets the value of created.

Parameters

$created
the created

Returns

Syspay_Merchant_Entity_Subscription
self
public DateTime
# getStartDate( )

Gets the value of start_date.

Gets the value of start_date.

Returns

DateTime
DateTime
public Syspay_Merchant_Entity_Subscription
# setStartDate( DateTime $start_date = null )

Sets the value of start_date.

Sets the value of start_date.

Parameters

$start_date
the start_date

Returns

Syspay_Merchant_Entity_Subscription
self
public DateTime
# getEndDate( )

Gets the value of end_date.

Gets the value of end_date.

Returns

DateTime
DateTime
public Syspay_Merchant_Entity_Subscription
# setEndDate( DateTime $end_date = null )

Sets the value of end_date.

Sets the value of end_date.

Parameters

$end_date
the end_date

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getStatus( )

Gets the value of status.

Gets the value of status.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setStatus( string $status )

Sets the value of status.

Sets the value of status.

Parameters

$status
the status

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getPhase( )

Gets the value of phase.

Gets the value of phase.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setPhase( string $phase )

Sets the value of phase.

Sets the value of phase.

Parameters

$phase
the phase

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getEndReason( )

Gets the value of end_reason.

Gets the value of end_reason.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setEndReason( string $end_reason )

Sets the value of end_reason.

Sets the value of end_reason.

Parameters

$end_reason
the end_reason

Returns

Syspay_Merchant_Entity_Subscription
self
public Syspay_Merchant_Entity_PaymentMethod
# getPaymentMethod( )

Gets the value of payment_method.

Gets the value of payment_method.

Returns

Syspay_Merchant_Entity_PaymentMethod
Syspay_Merchant_Entity_PaymentMethod
public Syspay_Merchant_Entity_Subscription
# setPaymentMethod( Syspay_Merchant_Entity_PaymentMethod $payment_method )

Sets the value of payment_method.

Sets the value of payment_method.

Parameters

$payment_method
the payment_method

Returns

Syspay_Merchant_Entity_Subscription
self
public integer
# getWebsite( )

Gets the value of website_id. Kept for BC.

Gets the value of website_id. Kept for BC.

Returns

integer
integer
public Syspay_Merchant_Entity_Subscription
# setWebsite( integer $website )

Sets the value of website_id Kept for BC.

Sets the value of website_id Kept for BC.

Parameters

$website
the website id

Returns

Syspay_Merchant_Entity_Subscription
self
public integer
# getWebsiteId( )

Gets the value of website_id.

Gets the value of website_id.

Returns

integer
integer
public Syspay_Merchant_Entity_Subscription
# setWebsiteId( integer $websiteId )

Sets the value of website_id

Sets the value of website_id

Parameters

$websiteId
the website id

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getEmsUrl( )

Gets the value of ems_url.

Gets the value of ems_url.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setEmsUrl( string $ems_url )

Sets the value of ems_url.

Sets the value of ems_url.

Parameters

$ems_url
the ems_url

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getRedirectUrl( )

Gets the value of redirect_url.

Gets the value of redirect_url.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setRedirectUrl( string $redirect_url )

Sets the value of redirect_url.

Sets the value of redirect_url.

Parameters

$redirect_url
the redirect_url

Returns

Syspay_Merchant_Entity_Subscription
self
public Syspay_Merchant_Entity_Customer
# getCustomer( )

Gets the value of customer.

Gets the value of customer.

Returns

Syspay_Merchant_Entity_Customer
Syspay_Merchant_Entity_Customer
public Syspay_Merchant_Entity_Subscription
# setCustomer( Syspay_Merchant_Entity_Customer $customer )

Sets the value of customer.

Sets the value of customer.

Parameters

$customer
the customer

Returns

Syspay_Merchant_Entity_Subscription
self
public Syspay_Merchant_Entity_Plan
# getPlan( )

Gets the value of plan.

Gets the value of plan.

Returns

Syspay_Merchant_Entity_Plan
Syspay_Merchant_Entity_Plan
public Syspay_Merchant_Entity_Subscription
# setPlan( Syspay_Merchant_Entity_Plan $plan )

Sets the value of plan.

Sets the value of plan.

Parameters

$plan
the plan

Returns

Syspay_Merchant_Entity_Subscription
self
public integer
# getPlanId( )

Gets the value of plan_id.

Gets the value of plan_id.

Returns

integer
integer
public Syspay_Merchant_Entity_Subscription
# setPlanId( integer $plan_id )

Sets the value of plan_id.

Sets the value of plan_id.

Parameters

$plan_id
the plan_id

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getPlanType( )

Gets the value of plan_type.

Gets the value of plan_type.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setPlanType( integer $plan_type )

Sets the value of plan_type.

Sets the value of plan_type.

Parameters

$plan_type
the plan_type

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getExtra( )

Gets the value of extra.

Gets the value of extra.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setExtra( string $extra )

Sets the value of extra.

Sets the value of extra.

Parameters

$extra
the extra

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getReference( )

Gets the value of reference.

Gets the value of reference.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setReference( string $reference )

Sets the value of reference.

Sets the value of reference.

Parameters

$reference
the reference

Returns

Syspay_Merchant_Entity_Subscription
self
public string
# getRedirect( )

Gets the value of redirect.

Gets the value of redirect.

Returns

string
string
public Syspay_Merchant_Entity_Subscription
# setRedirect( string $redirect )

Sets the value of redirect.

Sets the value of redirect.

Parameters

$redirect
the redirect

Returns

Syspay_Merchant_Entity_Subscription
self
public array
# toArray( )

Get an array representation of the object to build the request. It will collect all protected properties.

Get an array representation of the object to build the request. It will collect all protected properties.

Returns

array
An array to be used in the request

Overrides

Syspay_Merchant_Entity::toArray()
public Syspay_Merchant_Entity_SubscriptionEvent
# getNextEvent( )

Gets the next event

Gets the next event

Returns

Syspay_Merchant_Entity_SubscriptionEvent
Syspay_Merchant_Entity_SubscriptionEvent
public Syspay_Merchant_Entity_Subscription
# setNextEvent( Syspay_Merchant_Entity_SubscriptionEvent $next_event )

Sets the next event

Sets the next event

Parameters

$next_event
The next subscription event

Returns

Syspay_Merchant_Entity_Subscription
self
public integer
# getCaptureDelay( )

Gets the capture delay

Gets the capture delay

Returns

integer
int
public Syspay_Merchant_Entity_Subscription
# setCaptureDelay( integer $capture_delay )

Sets the capture delay

Sets the capture delay

Parameters

$capture_delay

Returns

Syspay_Merchant_Entity_Subscription
self
Methods inherited from Syspay_Merchant_Entity
getType()
Constants summary
string TYPE
#'subscription'
string STATUS_PENDING
#'PENDING'
string STATUS_ACTIVE
#'ACTIVE'
string STATUS_CANCELLED
#'CANCELLED'
string STATUS_ENDED
#'ENDED'
string STATUS_TERMINATED
#'TERMINATED'
string PHASE_NEW
#'NEW'
string PHASE_TRIAL
#'TRIAL'
string PHASE_BILLING
#'BILLING'
string PHASE_RETRY
#'RETRY'
string PHASE_LAST
#'LAST'
string PHASE_CLOSED
#'CLOSED'
string END_REASON_UNSUBSCRIBED_MERCHANT
#'UNSUBSCRIBED_MERCHANT'
string END_REASON_UNSUBSCRIBED_ADMIN
#'UNSUBSCRIBED_ADMIN'
string END_REASON_SUSPENDED_ATTEMPTS
#'SUSPENDED_ATTEMPTS'
string END_REASON_SUSPENDED_EXPIRED
#'SUSPENDED_EXPIRED'
string END_REASON_SUSPENDED_CHARGEBACK
#'SUSPENDED_CHARGEBACK'
string END_REASON_COMPLETE
#'COMPLETE'
Properties inherited from Syspay_Merchant_Entity
$raw
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0